~zenomat/tinywiki

b297a952c43a923d2b1aaf7ec0ba393c3af96fc8 — zeno 3 months ago 71b89b7
Update readme
1 files changed, 15 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +15 -0
@@ 14,3 14,18 @@ Tinywiki is a simple bash script, which converts a folder into a static html wik
- subfolders
- maybe some others I am forgetting
- (beautiful) styling

# Installation
``` bash
git clone https://git.sr.ht/~zenomat/tinywiki
cd tinywiki
mkdir -p $HOME/.local/share/tinywiki
cp style.css template.html $HOME/.local/share/tinywiki
```
- download [katex](https://cdnjs.com/libraries/KaTeX) `katex.min.{js,css}` to `$HOME/.local/share/tinywiki`

# Usage
- one `index.html` at the root
- insert `[[toc]]` to insert a toc at the place
- pass path of markdown folder to build.sh
- open `<folder>/public_html/index.html`