README.md (view raw)
1# Archie - Hugo theme
2Archie is a minimal and clean theme for hugo with a markdown-ish UI.
3
4Forked from [Ezhil Theme](https://github.com/vividvilla/ezhil)
5
6## Demo
7
8[Check the Demo](https://athul.github.io/archie/) hosted on GitHub Pages :smile: . You can find the source code to that in the `site` branch of this repository
9
10
11
12## Feature
13- Google Analytics Script
14- Callouts
15- Tags
16- Auto Dark Mode(based on system theme)
17- Dark/Light Mode toggle
18- tl:dr; frontamatter
19- Cache busting for CSS files
20
21## Installation
22In your Hugo website directory, create a new folder named theme and clone the repo
23```bash
24$ mkdir themes
25$ cd themes
26$ git clone https://github.com/athul/archie.git
27```
28Edit the `config.toml` file with `theme="archie"`
29For more information read the official [setup guide](https://gohugo.io/installation/) of Hugo.
30
31## Writing Posts
32Create a new `.md` file in the *content/posts* folder
33```yml
34---
35title: Title of the post
36description:
37date:
38tldr: (optional)
39draft: true/false (optional)
40tags: [tag names] (optional)
41---
42```
43
44## Credits
45Forked from [Ezhil Theme](https://github.com/vividvilla/ezhil) and Licensed under MIT License
46Inspired by design of blog.jse.li
47
48----
49
50## Config Options
51
52### Custom CSS
53Custom CSS files can be included though the `customcss` config parameter.
54
55Note: CSS files should be placed under the `assets` directory e.g. `assets/css/first.css`.
56
57```toml
58[params]
59 customcss = ["css/first.css", "css/second.css"]
60```
61
62
63## Config of the Demo Site
64
65```toml
66baseURL = "https://athul.github.io/archie/"
67languageCode = "en-us"
68title = "Archie"
69theme="archie"
70copyright = "© Athul"
71# Code Highlight
72pygmentsstyle = "monokai"
73pygmentscodefences = true
74pygmentscodefencesguesssyntax = true
75
76paginate=3 # articles per page
77
78[params]
79 mode="auto" # color-mode → light,dark,toggle or auto
80 useCDN=false # don't use CDNs for fonts and icons, instead serve them locally.
81 subtitle = "Minimal and Clean [blog theme for Hugo](https://github.com/athul/archie)"
82 mathjax = true # enable MathJax support
83 katex = true # enable KaTeX support
84
85# Social Tags
86
87[[params.social]]
88name = "GitHub"
89icon = "github"
90url = "https://github.com/athul/archie"
91
92[[params.social]]
93name = "Twitter"
94icon = "twitter"
95url = "https://twitter.com/athulcajay/"
96
97[[params.social]]
98name = "GitLab"
99icon = "gitlab"
100url = "https://gitlab.com/athul/"
101
102# Main menu Items
103
104[[menu.main]]
105name = "Home"
106url = "/"
107weight = 1
108
109[[menu.main]]
110name = "All posts"
111url = "/posts"
112weight = 2
113
114[[menu.main]]
115name = "About"
116url = "/about"
117weight = 3
118
119[[menu.main]]
120name = "Tags"
121url = "/tags"
122weight = 4
123```
124---
125
126If you liked my work please consider supporting me on [BuymeACoffee](https://www.buymeacoffee.com/athulca)
127
128<a href="https://www.buymeacoffee.com/athulca" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Coffee" height="41" width="174" ></a>