Website Summary Files Commits Branches @commit @diff @stats
path: root / website / themes / natrium / README.md
diff options
context:
space:
mode:
Commit3245f1f1404785d92c21eb381c08dee5a4be6bb7 (patch)
Author
 Dimitar Trendafilov <dimitar@coherent-labs.com>
2018-09-04 09:08:41 +0300
Committer
 Dimitar Trendafilov <dimitar@coherent-labs.com>
2018-09-04 09:08:41 +0300
Files3c245582fb5a2a9eaf8518f7272c03a6aaa2f635 /website/themes/natrium/README.md
IPL-3245f1f1404785d92c21eb381c08dee5a4be6bb7.tar
IPL-3245f1f1404785d92c21eb381c08dee5a4be6bb7.tar.gz
IPL-3245f1f1404785d92c21eb381c08dee5a4be6bb7.zip
Parentae12c0a482298e4da9b816137ceb6131c7d4b9e4 (diff)
Moved site to website folder
1 files changed, 65 insertions, 0 deletions
-rw-r--r--website/themes/natrium/README.md65
diff --git a/website/themes/natrium/README.md b/website/themes/natrium/README.md
new file mode 100644
index 0000000..fbf245e
--- /dev/null
+++ b/website/themes/natrium/README.md
@@ -0,0 +1,65 @@
+# Hugo Natrium
+
+A simple responsive blog theme for [Hugo](https://gohugo.io/) based on [Lithium](https://github.com/jrutheiser/hugo-lithium-theme.git)
+
+## Changes
+
+Natrium includes: taxonomies (categories, tags), static footer, new fonts (Roboto Mono, Font Awesome), local fonts, syntax highlighting, better support for code, img and RSS, pagination, multiple design optimizations, i18n, 404.html...
+
+## History
+
+I learned a lot while playing with the code from Lithium. I'm an absolutly beginner. Please report any issue you recognize.
+
+## Features
+
+- Blog
+- Responsive
+- Privacy (no Google)
+- Taxonomies
+- Syntax highlighting
+- Pagination
+
+## Installation
+
+Run the following inside your Hugo site folder:
+
+```
+$ mkdir themes
+$ cd themes
+$ git clone https://github.com/mobybit/hugo-natrium-theme
+```
+
+## Configuration
+
+Take a look at the sample [config.toml](https://github.com/mobybit/hugo-natrium-theme/blob/master/exampleSite/config.toml)
+file located in the [exampleSite](https://github.com/mobybit/hugo-natrium-theme/blob/master/exampleSite) folder.
+
+## Content Types
+
+### Post
+
+Used for blog posts. Blog posts are listed on the homepage.
+
+Run `hugo new post/<post-name>.md` to create a post.
+
+### Page
+
+Used for site pages.
+
+Run `hugo new page/<page-name>.md` to create a page.
+
+## Syntax highlighting
+
+Natrium is using [Chroma](https://gohugo.io/content-management/syntax-highlighting/) and `pygmentsStyle = "native"` by default. If you would like to use another style you have to adjust the colors in `pre` in main.css.
+
+## License
+
+The code is available under the [MIT License](https://github.com/mobybit/hugo-natrium-theme/blob/master/LICENSE.md).
+
+Natrium is using [Font Awesome](http://fontawesome.io) by Dave Gandy ([SIL OFL 1.1](http://scripts.sil.org/OFL)). Realated files (CSS, LESS, SCSS) are licensed under the [MIT License](http://opensource.org/licenses/mit-license.html).
+
+Other used fonts are [Merriweather](https://github.com/EbenSorkin/Merriweather) by Sorkin Type (Copyright © 2016 The Merriweather Project, [SIL OFL 1.1](http://scripts.sil.org/OFL)), [Lato](http://www.latofonts.com/) by Łukasz Dziedzic (Copyright © 2010-2014 by tyPoland Lukasz Dziedzic, [SIL OFL 1.1](http://scripts.sil.org/OFL)) and [Roboto Mono](https://github.com/google/roboto/) by Christian Robertson (Copyright © 2015 Google Inc., [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)).
+
+Special thanks to [Artem Sidorenko](https://www.sidorenko.io/post/2017/07/nice-tagcloud-with-hugo/) (tag cloud).
+
+The content of the example site is generated with [Metamorphosum](http://metaphorpsum.com/) (Copyright © 2014 Kyle Stetz, [MIT License](https://github.com/kylestetz/metaphorpsum/blob/master/LICENSE.md)).