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
  • 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.9.0.tar.gz (9.6 MB view details)

Uploaded Source

Built Distribution

wikmd-1.9.0-py3-none-any.whl (9.6 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wikmd-1.9.0.tar.gz
Algorithm Hash digest
SHA256 4fa9e096c512160df975bda187b9de4d70b08b96c899eefd2ad3a3346d1a397b
MD5 270ee34d65646a7d76e1f868b6217894
BLAKE2b-256 52f48b37b1c268d78f66407311d733ca5b876851e2858a0bbaa1823ae9fe8b1b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for wikmd-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 14f2403991a308cabfa13ce58a3ad4c04f6e8a126d331608080454615809a965
MD5 ffdef32d479cdaf8e77ecf8c46ed15ce
BLAKE2b-256 a23007601e597f3ef29c405f37bc703d729b02ad04367ab5601efa9949f2e910

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