themu/README.md

45 lines
1.1 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
[Check the Demo](https://athul.github.io/archie/) hosted on GitHub Pages :smile:
![](/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)
2020-04-11 17:45:12 +03:00
- tl:dr; frontamatter
## 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"`
For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo.
## 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
2020-04-16 19:18:45 +03:00
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