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- tl:dr; frontamatter
18- Cache busting for CSS files
19
20## Installation
21In your Hugo website directory, create a new folder named theme and clone the repo
22```bash
23$ mkdir themes
24$ cd themes
25$ git clone https://github.com/athul/archie.git
26```
27Edit the `config.toml` file with `theme="archie"`
28For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo.
29
30## Writing Posts
31Create a new `.md` file in the *content/posts* folder
32```yml
33---
34title: Title of the post
35description:
36date:
37tldr: (optional)
38draft: true/false (optional)
39tags: [tag names] (optional)
40---
41```
42
43## Credits
44Forked from [Ezhil Theme](https://github.com/vividvilla/ezhil) and Licensed under MIT License
45Inspired by design of blog.jse.li
46
47----
48
49## Config Options
50
51### Custom CSS
52Custom CSS files can be included though the `customcss` config parameter.
53
54Note: CSS files should be placed under the `assets` directory e.g. `assets/css/first.css`.
55
56```toml
57[params]
58 customcss = ["css/first.css", "css/second.css"]
59```
60
61
62## Config of the Demo Site
63
64```toml
65baseURL = "https://athul.github.io/archie/"
66languageCode = "en-us"
67title = "Archie"
68theme="archie"
69copyright = "© Athul"
70# Code Highlight
71pygmentsstyle = "monokai"
72pygmentscodefences = true
73pygmentscodefencesguesssyntax = true
74
75paginate=3 # articles per page
76
77[params]
78 mode="auto" # color-mode → light,dark or auto
79 useCDN=false # don't use CDNs for fonts and icons, instead serve them locally.
80 subtitle = "Minimal and Clean [blog theme for Hugo](https://github.com/athul/archie)"
81
82# Social Tags
83
84[[params.social]]
85name = "GitHub"
86icon = "github"
87url = "https://github.com/athul/archie"
88
89[[params.social]]
90name = "Twitter"
91icon = "twitter"
92url = "https://twitter.com/athulcajay/"
93
94[[params.social]]
95name = "GitLab"
96icon = "gitlab"
97url = "https://gitlab.com/athul/"
98
99# Main menu Items
100
101[[menu.main]]
102name = "Home"
103url = "/"
104weight = 1
105
106[[menu.main]]
107name = "All posts"
108url = "/posts"
109weight = 2
110
111[[menu.main]]
112name = "About"
113url = "/about"
114weight = 3
115
116[[menu.main]]
117name = "Tags"
118url = "/tags"
119weight = 4
120```
121---
122
123If you liked my work please consider supporting me on [BuymeACoffee](https://www.buymeacoffee.com/athulca)
124
125<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>