all repos — archie @ acd619ee67515f9b7bc52f250f02fe93fc955583

A minimal Hugo Theme

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![](/images/theme.png)
 11![](/images/archie-dark.png)
 12## Feature
 13- Google Analytics Script
 14- Callouts
 15- Tags
 16- Auto Dark Mode(based on system theme)
 17- tl:dr; frontamatter
 18
 19## Installation
 20In your Hugo website directory, create a new folder named theme and clone the repo
 21```bash
 22$ mkdir themes
 23$ cd themes
 24$ git clone https://github.com/athul/archie.git
 25```
 26Edit the `config.toml` file with `theme="archie"`
 27For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo.
 28
 29## Writing Posts
 30Create a new `.md` file in the *content/posts* folder
 31```yml
 32---
 33title: Title of the post
 34description:
 35date:
 36tldr: (optional)
 37draft: true/false (optional)
 38tags: [tag names] (optional)
 39---
 40```
 41
 42## Credits
 43Forked from [Ezhil Theme](https://github.com/vividvilla/ezhil) and Licensed under MIT License 
 44Inspired by design of blog.jse.li
 45
 46----
 47
 48## Config of the Demo Site
 49
 50```toml
 51baseURL = "https://athul.github.io/archie/"
 52languageCode = "en-us"
 53title = "Archie"
 54theme="archie"
 55copyright = "© Athul"
 56# Code Highlight
 57pygmentsstyle = "monokai"
 58pygmentscodefences = true
 59pygmentscodefencesguesssyntax = true
 60
 61paginate=3 # articles per page
 62
 63[params]
 64	mode="auto" # color-mode → light,dark or auto
 65	featherIconsCDN=true
 66	subtitle = "Minimal and Clean [blog theme for Hugo](https://github.com/athul/archie)"
 67
 68# Social Tags
 69
 70[[params.social]]
 71name = "GitHub"
 72icon = "github"
 73url = "https://github.com/athul/archie"
 74
 75[[params.social]]
 76name = "Twitter"
 77icon = "twitter"
 78url = "https://twitter.com/athulcajay/"
 79
 80[[params.social]]
 81name = "GitLab"
 82icon = "gitlab"
 83url = "https://gitlab.com/athul/"
 84
 85# Main menu Items
 86
 87[[menu.main]]
 88name = "Home"
 89url = "/"
 90weight = 1
 91
 92[[menu.main]]
 93name = "All posts"
 94url = "/posts"
 95weight = 2
 96
 97[[menu.main]]
 98name = "About"
 99url = "/about"
100weight = 3
101
102[[menu.main]]
103name = "Tags"
104url = "/tags"
105weight = 4
106```