Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/siegerts/hugo-theme-basic.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsiegerts <stephen.siegert@gmail.com>2019-02-11 01:30:56 +0300
committersiegerts <stephen.siegert@gmail.com>2019-02-11 01:30:56 +0300
commit103387d2156b0155f36252079cfe591e09d843e3 (patch)
tree3fdc7009c9f3757a54b6c77913c11ae7224f8c10
parentf2ebdd4efcf38dfbc6c11b34a91d129f688f8331 (diff)
update readme
-rw-r--r--README.md47
1 files changed, 46 insertions, 1 deletions
diff --git a/README.md b/README.md
index 84460f0..49c89c6 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,12 @@
Basic personal site theme styled with minimal tachyons.
+## Features
+
+- ✨ Basic — HTML with a dash of style + emojis stand out more
+- 🌯 Extensible — Easily leverage [tachyons](https://tachyons.io/components/) to spice it up
+-
+
## Getting started
### Installation
@@ -24,8 +30,47 @@ For more information, read the official [documentation](https://gohugo.io/themes
### Configuration
-The example configuration file can be found in the theme's `exampleSite` folder. You can just copy the `config.toml` to the root directory of your Hugo site. There are instructions in the example configuration file, feel free to change strings as you like to customize your website.
+Take a look at the sample `config.toml`file located in the `exampleSite` folder. You can just copy the `config.toml` to the root directory of your Hugo site. There are instructions in the example configuration file, feel free to change strings as you like to customize your website.
+
+#### Content Types
+
+**Post**
+<br />
+Used for blog posts. Posts are listed on the `/blog` page. Run `hugo new post/<post-name>.md` to create a post.
+<br />
+
+**Page** _Optional_
+<br />
+Used for site pages. Run `hugo new page/<page-name>.md` to create a page.
+<br />
+
+**Project** _Optional_
+<br />
+Used for project pages. Extend project list with `/layouts/section/project.html`. Run `hugo new project/<project-name>.md` to create a page.
+<br />
+
+#### Menu
+
+Menu links are specified, in order, in the theme configuration.
+
+For example:
+
+```toml
+[[params.menu]]
+ name = "blog"
+ url = "blog/"
+
+
+[[params.menu]]
+ name = "about"
+ url = "page/about"
+
+```
## Acknowledgments
- [tachyons](http://tachyons.io/)
+
+## License
+
+The code is available under the [MIT license](https://github.com/siegerts/hugo-theme-basic/blob/master/LICENSE).