https://github.com/linbreux/wikmd

A file based wiki that uses markdown
https://github.com/linbreux/wikmd

docker documentation html knowledge-graph latex markdown markdown-editor markdown-to-html markdown-viewer obsidian pandoc personal-wiki python selfhost wiki

Last synced: 25 days ago
JSON representation

A file based wiki that uses markdown

• Host: GitHub
• URL: https://github.com/linbreux/wikmd
• Owner: Linbreux
• License: mit
• Created: 2020-11-24T13:54:03.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T19:56:24.000Z (about 2 months ago)
• Last Synced: 2024-10-14T07:40:52.787Z (25 days ago)
• Topics: docker, documentation, html, knowledge-graph, latex, markdown, markdown-editor, markdown-to-html, markdown-viewer, obsidian, pandoc, personal-wiki, python, selfhost, wiki
• Language: Python
• Homepage: https://linbreux.github.io/wikmd/
• Size: 11.2 MB
• Stars: 339
• Watchers: 6
• Forks: 37
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# wikmd 

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/linbreux/wikmd/docker.yml?style=flat-square) ![GitHub Repo stars](https://img.shields.io/github/stars/linbreux/wikmd?style=flat-square) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/linbreux/wikmd?style=flat-square) ![GitLab](https://img.shields.io/gitlab/license/linbreux/wikmd?style=flat-square)

> :information_source: **Information** can be found in the docs: [https://linbreux.github.io/wikmd/](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](src/wikmd/static/images/readme-img.png)

## 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](https://linbreux.github.io/wikmd/Using%20the%20wiki.html)

## Installation

Detailed installation instruction can be found [here](https://linbreux.github.io/wikmd/installation.html).

## Development

Instructions on the easiest way to develop on the project can be found [here](https://linbreux.github.io/wikmd/development.html).

## Plugins & Knowledge graph (beta)

More info can be found in the [docs](https://linbreux.github.io/wikmd/knowledge%20graph.html).