/wikmd

A file based wiki that uses markdown

Primary LanguagePythonMIT LicenseMIT

wikmd

ℹ️ Information can be found in the docs: https://linbreux.github.io/wikmd/

preview

What is it?

It’s a file-based wiki that aims to simplicity. The documents are completely written in Markdown which is an easy markup language that you can learn in 60 sec.

How does it work?

Instead of storing the data in a database I chose to have a file-based system. The advantage of this system is that every file is directly readable inside a terminal etc. Also when you have direct access to the system you can export the files to anything you like.

To view the documents in the browser, the document is converted to html.

Features

  • knowledge graph
  • git support (version control)
  • image support including sizing and referencing
  • math/latex
  • code highlight
  • file searching
  • file based
  • dark theme
  • codemirror for editing
  • password protection

Installation

Detailed installation instruction can be found here.

Knowledge graph (beta)

More info can be found in the docs.

Knowledge graph

How to use wikmd

Using the wiki