diff options
author | Yurizal Susanto <rizalsagi@gmail.com> | 2019-08-24 04:54:00 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-08-24 04:54:00 +0300 |
commit | 0c314fde003a7b4d3f12e43228b9c55b6a96b7c1 (patch) | |
tree | 761094b976151ada41cafdf1bc265c35ab76659c | |
parent | 9e504cec9f2e50022b3bf070266673dd0435ba2b (diff) |
Update README.md
Add instruction for adding custom CSS with the theme
-rw-r--r-- | README.md | 45 |
1 files changed, 39 insertions, 6 deletions
@@ -3,10 +3,22 @@ It's a minimalist and responsive theme for Hugo Static Site Generator. It's name taken from Indonesian Language for *Sweet*. -> Note: Manis going to follow [SEMVER](https://semver.org/) scheme from now. It's mean you can clone this repository from master without breaking. - ![Manis' Mockup Device](https://raw.githubusercontent.com/yursan9/manis-hugo-theme/master/images/mockup.jpg) +## Table of Contents + +- [Features](https://github.com/yursan9/manis-hugo-theme#features) +- [Get Started](https://github.com/yursan9/manis-hugo-theme#get-started) + + [Theme Only](https://github.com/yursan9/manis-hugo-theme#theme-only) +- [Configuration](https://github.com/yursan9/manis-hugo-theme#configuration) + + [Change Latest Section](https://github.com/yursan9/manis-hugo-theme#change-latest-section) + + [Custom CSS](https://github.com/yursan9/manis-hugo-theme#custom-css) + + [Disqus Configuration](https://github.com/yursan9/manis-hugo-theme#disqus-configuration) + + [Making Own Navigation Bar](https://github.com/yursan9/manis-hugo-theme#making-own-navigation-bar) + + [Other Language](https://github.com/yursan9/manis-hugo-theme#other-language) +- [Development](https://github.com/yursan9/manis-hugo-theme#development) +- [License](https://github.com/yursan9/manis-hugo-theme#license) + ## Features Like I said, it's really minimal. Its doesn't even have grid or anything nice like that. @@ -71,6 +83,27 @@ mainSections = ["blog", "post"] workSections = ["work"] ``` +### Custom CSS +If you want to make a change for this theme, other than forking, you can also supplied custom CSS. Maybe you want to change the font or size of image or icon, then custom CSS is your pal. + +First, edit your `config.toml`, add the custom CSS filenames to `custom CSS`. You can supplied more than one custom CSS. Just be aware of the CSS load order. + +``` +[params] + customCSS = ["/css/icon.css"] +``` + +Then, make a new `static/css/icon.css` file. After that you can write your custom CSS to that file: + +``` +.icon-social { + width: 2rem; + height: 2rem; +} +``` + +If you follow the above instruction, you will change the size of icon on footer without forking the theme. + ### Disqus Configuration To add Disqus support, edit your site `config.toml`. Add your discus' shortname to `disqusShortname` and add list of sections that you want to support disqus to `params.disqusSections`: @@ -78,7 +111,7 @@ To add Disqus support, edit your site `config.toml`. Add your discus' shortname disqusShortname = "your-disqus-shortname" [params] - disqusSections = ["blog"] + disqusSections = ["blog"] ``` ### Making Own Navigation Bar @@ -106,9 +139,9 @@ And then you edit the site's `config.toml` like this. ```toml defaultContentLanguage = "en" [languages.{Your Language Code}] - lang = "{Your Language Code}" - languageName = "{Your Language Name. example; Bahasa Indonesia or Japanese}" - weight = 1 + lang = "{Your Language Code}" + languageName = "{Your Language Name. example; Bahasa Indonesia or Japanese}" + weight = 1 ``` ## Development |