diff options
Merge commit 'fba5befbf5b9cb9b9026b8f6af7f6c5444e1a8f5' as 'website/themes/base16'
1 files changed, 46 insertions, 0 deletions
| -rw-r--r-- | website/themes/base16/README.md | 46 |
diff --git a/website/themes/base16/README.md b/website/themes/base16/README.md new file mode 100644 index 0000000..9264502 --- /dev/null +++ b/website/themes/base16/README.md @@ -0,0 +1,46 @@ +# Base16 Theme for Hugo + + + +## Installation + + $ mkdir themes + $ cd themes + $ git clone https://github.com/htdvisser/hugo-base16-theme.git base16 + +See [the Hugo documentation](http://gohugo.io/themes/installing/) for more information. + +## Extra Features + +### Syntax highlighting + +This theme has support for `highlight` shortcode (with Pygments), +see [the Hugo documentation](http://gohugo.io/extras/highlighting/) for more information. + +To use this feature install Pygments (`pip install Pygments`) and add `pygmentsuseclasses = true` to your `config.toml`. + +### Figure shortcode + +Use the `figure` shortcode if you want nice rendering of pictures, see [the Hugo documentation](http://gohugo.io/extras/shortcodes/) for more information. + + +## Customization + +You probably want to edit the homepage. Get started by copying the supplied homepage to your own site. + + $ mkdir -p layouts/partials + $ cp themes/base16/layouts/partials/hero.html layouts/partials/hero.html + +After this, you can edit `layouts/partials/hero.html` and make it awesome. + + +## License + +MIT Licensed, see [LICENSE](https://github.com/htdvisser/hugo-base16-theme/blob/master/LICENSE). + + +## Don't forget to thank... + +[Steve Francia](https://github.com/spf13) for Hugo. +[Chris Kempson](http://chriskempson.com) for the Base16 Eighties Colorscheme. +[Jan T. Sott](https://github.com/idleberg) for the Pygments template. |
