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.3.tar.gz (10.0 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wikmd-1.10.3.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.3.tar.gz
Algorithm Hash digest
SHA256 0de9895d40234dc1365ce5f1ecff172ea4b3c094924a89b2585d884abe0eb0bd
MD5 0af35f7c4dd443634bbc60ffff122477
BLAKE2b-256 d5425d7a483b4f11c37b8e35fcd647aa1cc297eb1287fea0bd5ab7f76cdf6d6b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wikmd-1.10.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 677fb5d87c53fabc4e4246b9de27d83003a58e024c4dbb8f9f945a268e2b1c24
MD5 7a1c3c4ad14c891f5ffeb8232d85ec9a
BLAKE2b-256 0291ff539b4ff741e8282e84fb1ae4b1ed0dcc77260c0ebf3816425686e0818f

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