Skip to main content

A file-based wiki that aims for simplicity.

Project description

wikmd

GitHub Workflow Status GitHub Repo stars GitHub release (latest by date) GitLab

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

What is it?

It’s a file-based wiki that aims to simplicity. 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.

preview

Features

  • knowledge graph
  • NEW plugin system: drawio integration, alerts, embedded pages, swagger, plantuml
  • 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

Using the wiki

Installation

Detailed installation instruction can be found here.

Development

Instructions on the easiest way to develop on the project can be found here.

Plugins & Knowledge graph (beta)

More info can be found in the docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wikmd-1.10.5.tar.gz (10.0 MB view details)

Uploaded Source

Built Distribution

wikmd-1.10.5-py3-none-any.whl (10.0 MB view details)

Uploaded Python 3

File details

Details for the file wikmd-1.10.5.tar.gz.

File metadata

  • Download URL: wikmd-1.10.5.tar.gz
  • Upload date:
  • Size: 10.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for wikmd-1.10.5.tar.gz
Algorithm Hash digest
SHA256 fefc9eb60ae8364ed7b16a154caa8de18c20cb6c33e8e0752b989d2bba573eb1
MD5 7691d3218518800d3abe4f6812da486e
BLAKE2b-256 9669528c0a3e3e2e0b45d6216aace48491bb1fff7e5e9546e6ac95c9be5297b0

See more details on using hashes here.

File details

Details for the file wikmd-1.10.5-py3-none-any.whl.

File metadata

  • Download URL: wikmd-1.10.5-py3-none-any.whl
  • Upload date:
  • Size: 10.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for wikmd-1.10.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c87726aa7566e57365e35ad3b56b4f0cbfb32194f4495d06bbd6abec2e37c46b
MD5 d97976fbf0bd1461dcffda46ee9408e1
BLAKE2b-256 ded9e73fc746ed614f52faf1f3b147f7c5292a3605b4ea3e7f985a053fb3aa7a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page