~zenomat/tinywiki

ref: 0dac8299ff5fe12f2b1a7dc70c8dd765d4ad03ad tinywiki/README.md -rw-r--r-- 939 bytes
0dac8299 — zeno fix toc in subfolders not using relative path from their dir 3 months ago

Tinywiki is a simple bash script, which converts a folder into a static html wiki.

  • this is in a super rough state at the moment
  • improvments will come till it is in a state where:
    • you git clone the repo
    • issue one command
    • have a static html wiki
  • Requires bash

#Features

  • Table of contents insertion with [[toc]]
  • katex math (katex libs locally, so no external cdns)
  • pandoc frontmatter
  • subfolders
  • maybe some others I am forgetting
  • (beautiful) styling

#Installation

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 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