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

github.com/yursan9/manis-hugo-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYurizal Susanto <rizal.sagi@gmail.com>2017-07-03 07:07:52 +0300
committerYurizal Susanto <rizal.sagi@gmail.com>2017-07-03 07:07:52 +0300
commitadaf0179dc053bcbf27f9a826938fbd88494c792 (patch)
tree5d1cd20ed5be1a98012fe3f69323a22f77e0efb3
parent49be2dfead1779f83777a1b156cb648c7795e9bb (diff)
Add some nice thing to README
-rw-r--r--README.md66
1 files changed, 60 insertions, 6 deletions
diff --git a/README.md b/README.md
index b5acabf..466ea94 100644
--- a/README.md
+++ b/README.md
@@ -3,15 +3,69 @@
It's a minimalist and responsive theme for Hugo Static Site Generator. It's
name taken from Indonesian Language for *Sweet*.
+![Manis' Homepage view]()
+
## Features
-Like I said, it's really minimal (and lacking in documentation)
+Like I said, it's really minimal. Its doesn't even have grid or anything nice like that.
+
+- Configurable color!
+- Code Highlighting (HighlightJS).
+- Social Icon Links.
+- No Grid no worry.
+- Can be translated.
+
+![Manis' Colorful scheme]()
+
+## Installation
+
+To install Manis, you can clone this repository. The following command will clone Manis in your site's base directory.
+
+```
+cd path/to/site/dir
+git clone https://github.com/yursan9/manis-hugo-theme themes/manis
+```
+
+## Configuration
+
+For configuration example you can look at the `example/config.toml` (and copy that too!). I put some commentary to, hopefully, guide you at using this theme.
+
+### Making Own Navigation Bar
-- Code Highlighting (HighlightJS)
-- Social Icon Links
-- Mobile First using Flexbox Grid
-- Can be translated
+Top navigation bar in Manis is made automatically by making new `section/_index.md`. Example if you want to add/remove navigation items, you can do the following command:
-## Translating String
+```
+hugo new {Section Name}/_index.md
+```
+
+And make sure the front matter is formatted like this:
+
+```
++++
+title = "Get To Know Me"
+menu = "main"
++++
+```
+
+`title` will be the string that is shown in navigation bar and the page's title (the title doesn't need to be the same as section's name). `menu = "main"` is the one who make Hugo know how identify it's need to add a new item in navigation bar.
+
+## Other Language
Manis already translated to Bahasa Indonesia. But, if you want to translate this theme to your own language, look for the example in `i18n/en.yaml` and `i18n/in.yaml`.
+
+And then you edit the site's `config.toml` like this.
+```
+defaultContentLanguage = "en"
+[languages.{Your Language Code}]
+ lang = "{Your Language Code}"
+ languageName = "{Your Language Name. example; Bahasa Indonesia or Japanese}"
+ weight = 1
+```
+
+## Development
+
+If you found bug, or anything that itch you. Tell me! or maybe make PR.
+
+## License
+
+Manis is licensed under the MIT License. Check the [LICENSE](https://github.com/yursan9/manis-hugo-theme/blob/master/LICENSE.md) file for details.