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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wikmd-1.10.6.tar.gz
Algorithm Hash digest
SHA256 fe810d42865ee06b7ac35780575f29cd1c904ddbdfe499154617c6353a3cb45f
MD5 e95ef4f5d18ca181ccd9846c07cf86b6
BLAKE2b-256 bbb8f5b1aaa8ed8d21344d72c02d965609f62a8b7c5acce9a063bb43cdbed583

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wikmd-1.10.6-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.20

File hashes

Hashes for wikmd-1.10.6-py3-none-any.whl
Algorithm Hash digest
SHA256 f42e0e91938fc74840531313aba534df541942d283aedfd79a5a91b4aafc5a73
MD5 4f82dcdff4063d30561ec99c2d8735c2
BLAKE2b-256 27807dbd40a18241ed8b4c107558a130f6b88039fcb7c99974de216e5fcd4ddb

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