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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wikmd-1.10.1.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.10.1.tar.gz
Algorithm Hash digest
SHA256 26cd92fe781f6d2995bc35fd77c461819c0e07a5da661fa63f8df54a37791d49
MD5 e74b742f0c41d7f44a73ed7d15032eea
BLAKE2b-256 2be3bfc2d3ad6e53bf834b740579bdcaf755543b23bb8389bb1600a2b1fa6728

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wikmd-1.10.1-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.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7123cdca9f554390e6331f1a4c98fc88c0f63183c3e67a901234346cfa6a2604
MD5 49cd9ba05ef1a6c12bf9707a58a2ee94
BLAKE2b-256 d6010d5346f0baad1eec3874653b6c6bb3cfc73b6d51b78b2b164f60eb93f2a4

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