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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wikmd-1.10.4.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.4.tar.gz
Algorithm Hash digest
SHA256 b5bb25b12221df02f547b5b7c3cc6618d052ee840057af38aa8fb92cea2077cb
MD5 c8cb1f4fcf1fd755c1991f745ce19bb8
BLAKE2b-256 f4dfcf6047d6b88b43d1149485f288c3f1c04aff64a5e1afbd57e08388eb51d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wikmd-1.10.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c4545d027762725d8122cffe02137fff9ea7ef14700915e462c46cf029c1ccb8
MD5 3610a5fc7f9830ef0e0e5873d1fb988d
BLAKE2b-256 e085444453d01f982934cbc6d37840f7eac97b7f0b23a861915c6db3189cd15f

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