themu/README.md

132 lines
2.9 KiB
Markdown
Raw Normal View History

2020-04-09 09:36:48 +03:00
# Archie - Hugo theme
2020-04-11 17:45:12 +03:00
Archie is a minimal and clean theme for hugo with a markdown-ish UI.
Forked from [Ezhil Theme](https://github.com/vividvilla/ezhil)
## Demo
2020-05-04 22:14:33 +03:00
[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
2020-04-11 17:45:12 +03:00
![](/images/theme.png)
2020-04-16 20:30:30 +03:00
![](/images/archie-dark.png)
2020-04-11 17:45:12 +03:00
## Feature
- Google Analytics Script
- Callouts
- Tags
2020-04-16 19:18:45 +03:00
- Auto Dark Mode(based on system theme)
2021-09-25 19:23:24 +03:00
- Dark/Light Mode toggle
2020-04-11 17:45:12 +03:00
- tl:dr; frontamatter
- Cache busting for CSS files
- Disqus Comments
2020-04-11 17:45:12 +03:00
## Installation
In your Hugo website directory, create a new folder named theme and clone the repo
```bash
$ mkdir themes
$ cd themes
$ git clone https://github.com/athul/archie.git
```
Edit the `config.toml` file with `theme="archie"`
2022-11-11 09:52:05 +03:00
For more information read the official [setup guide](https://gohugo.io/installation/) of Hugo.
2020-04-11 17:45:12 +03:00
## Writing Posts
2020-04-16 19:18:45 +03:00
Create a new `.md` file in the *content/posts* folder
2020-04-11 17:45:12 +03:00
```yml
---
title: Title of the post
description:
date:
tldr: (optional)
2020-04-16 19:18:45 +03:00
draft: true/false (optional)
tags: [tag names] (optional)
2020-04-11 17:45:12 +03:00
---
```
## Credits
Forked from [Ezhil Theme](https://github.com/vividvilla/ezhil) and Licensed under MIT License
2020-04-16 20:30:30 +03:00
Inspired by design of blog.jse.li
2020-05-04 22:14:33 +03:00
----
## Config Options
### Custom CSS
Custom CSS files can be included though the `customcss` config parameter.
Note: CSS files should be placed under the `assets` directory e.g. `assets/css/first.css`.
```toml
[params]
customcss = ["css/first.css", "css/second.css"]
```
2020-05-04 22:14:33 +03:00
## Config of the Demo Site
```toml
baseURL = "https://athul.github.io/archie/"
languageCode = "en-us"
title = "Archie"
theme="archie"
copyright = "© Athul"
# Code Highlight
pygmentsstyle = "monokai"
pygmentscodefences = true
pygmentscodefencesguesssyntax = true
disqusShortname = "yourDisqusShortname"
2020-05-04 22:14:33 +03:00
paginate=3 # articles per page
[params]
2021-09-25 19:23:24 +03:00
mode="auto" # color-mode → light,dark,toggle or auto
useCDN=false # don't use CDNs for fonts and icons, instead serve them locally.
2020-05-04 22:14:33 +03:00
subtitle = "Minimal and Clean [blog theme for Hugo](https://github.com/athul/archie)"
mathjax = true # enable MathJax support
katex = true # enable KaTeX support
2020-05-04 22:14:33 +03:00
# Social Tags
[[params.social]]
name = "GitHub"
icon = "github"
url = "https://github.com/athul/archie"
[[params.social]]
name = "Twitter"
icon = "twitter"
2020-09-16 14:35:03 +03:00
url = "https://twitter.com/athulcajay/"
2020-05-04 22:14:33 +03:00
[[params.social]]
name = "GitLab"
icon = "gitlab"
url = "https://gitlab.com/athul/"
# Main menu Items
[[menu.main]]
name = "Home"
url = "/"
weight = 1
[[menu.main]]
name = "All posts"
url = "/posts"
weight = 2
[[menu.main]]
name = "About"
url = "/about"
weight = 3
[[menu.main]]
name = "Tags"
url = "/tags"
weight = 4
```
2021-03-01 18:50:33 +03:00
---
If you liked my work please consider supporting me on [BuymeACoffee](https://www.buymeacoffee.com/athulca)
<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>