Probably old hat to some…but documentation is important. Just for once…I am trying to keep documentation AHEAD of the inevitable bork that destroys everything… so that in 3 months time I don’t have to reconstitute everything out of thin air and swearing.

Anyhow, I came across this lovely little repo a while ago and though “yes, next time, use this”

https://github.com/Zavy86/WikiDocs

And so I am :)

I’ll let the author speak to the perks (no affiliation, I just like wikidocs and wanted to share it)

  • Open source
  • Plain text files
  • No database required
  • Markdown syntax
  • YAML Frontmatter
  • Editor full WYSIWYG
  • Support for KaTeX math
  • Support for Mermaid diagrams
  • Unlimited page revisions
  • Uploading and downloading attachments
  • Uploading images (also from clipboard)
  • Content can be categorized in namespaces
  • Public and private browsing
  • Desktop and remote sync
  • Syntax highlighting
  • Multiple languages
  • Dark mode

While I show off a happy snap