diff options
Diffstat (limited to 'backend/ikistrap/README.md')
-rw-r--r-- | backend/ikistrap/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/backend/ikistrap/README.md b/backend/ikistrap/README.md new file mode 100644 index 0000000..76c6f14 --- /dev/null +++ b/backend/ikistrap/README.md @@ -0,0 +1,15 @@ +# Ikistrap, a Bootstrap 4 theme for ikiwiki + +[Ikiwiki](https://ikiwiki.info/) is a very powerful [wiki](https://en.wikipedia.org/wiki/Wiki) compiler. +However, its default theme is very minimalistic. +Ikistrap is a theme that uses [Bootstrap 4](http://v4-alpha.getbootstrap.com/) to ensure you have a wiki that looks professional, +whether you are viewing it on your desktop computer or on your mobile phone. + +To use ikistrap in your own wiki, just add the following to your setup file: + + templatedir: /path/to/ikistrap/templates + underlaydir: /path/to/ikistrap/basewiki + +Ikistrap comes with an example wiki that shows off its features, +and shows you how to integrate some Bootstrap 4 features into your `.mdwn` files. +Use the `Makefile` to compile the example wiki. |