Website Summary Files Commits Branches @commit @diff @stats
path: root / README.md
diff options
context:
space:
mode:
Commitfba5befbf5b9cb9b9026b8f6af7f6c5444e1a8f5 (patch)
Author
 Dimitar Trendafilov <dimitar@coherent-labs.com>
2018-10-04 15:15:57 +0300
Committer
 Dimitar Trendafilov <dimitar@coherent-labs.com>
2018-10-04 15:15:57 +0300
Filesf25c11016c9ec94f27f928ca00fe0173b71dda59 /README.md
IPL-fba5befbf5b9cb9b9026b8f6af7f6c5444e1a8f5.tar
IPL-fba5befbf5b9cb9b9026b8f6af7f6c5444e1a8f5.tar.gz
IPL-fba5befbf5b9cb9b9026b8f6af7f6c5444e1a8f5.zip
Squashed 'website/themes/base16/' content from commit 7b2da73
git-subtree-dir: website/themes/base16 git-subtree-split: 7b2da739c813cd680e44606d2150e3c66a6794e6
1 files changed, 46 insertions, 0 deletions
-rw-r--r--README.md46
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9264502
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Base16 Theme for Hugo
+
+![Hugo Base16 Theme screenshot](https://raw.githubusercontent.com/htdvisser/hugo-base16-theme/master/images/screenshot.png)
+
+## 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.