~zenomat/tinywiki

ref: 427a81d5b39a35d4c16842907c9616fde716429b tinywiki/README.md -rw-r--r-- 1.2 KiB
427a81d5 — zeno Add basepath 3 months ago

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

  • No external JS is downloaded or called

  • Only JS used is Katex, only if Katex math is included, and only in that file

  • Katex lives locally

  • 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

#Features

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

#Requirements

  • bash (not posix yet)
  • pandoc
  • coreutils

#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 [[index]] to insert an index of files
  • pass path of markdown folder to build.sh
  • optionally pass basedir as second arg, if you want to deploy to a webserver
  • open <folder>/public_html/index.html