It’s a file-based wiki that aims to simplicity. The documents are completely written in Markdown which is an easy markup language that you can learn in 60 sec.
If you compare markdown to a WYSIWYG editor it may look less easy to use but the opposite is true. When writing markdown you don’t get to see the result directly which is the only downside. Their are more pros: - Easy to process to other file formats - Scalable, it reformats for the perfect display width
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.
- 26/11/20
- added git support
- added image support
! It's tested on windows and linux based systems. ! Runs on flask server
Clone te repository
git clone https://github.com/Linbreux/wikmd.git
cd in wikmd
cd wikmd
Create a virtual env and activate it(optional)
virtualenv venv
source venv/bin/activate
Install requirements
pip install -r requirements.txt
Run the wiki
export FLASK_APP=wiki.py
flask run --host=0.0.0.0
Maybe you need to install pandoc on your system before this works.
sudo apt-get update && sudo apt-get install pandoc
Now visit localhost:5000 and you will see the wiki. With the 0.0.0.0. option it will show up everywhere on the network.
docker build -t wiki-md:latest .
You may need to create wiki/data in your homefolder or you can change it if you want another place.
sudo docker run -d -p 5000:5000 -v ~/wiki/data:/app/wiki wiki-md
If you would like to have the default files inside your instance, you should copy the wiki files to ~/wiki/data in this case. Also highly recommended is to create a folder 'img' inside 'wiki/'
cp wikmd/wiki/* ~/wiki/data/
mkdir ~/wiki/img
The homepage is default the "homepage.md" file, this can't be changed. If this file doesn't exist create it in de wiki folder.
If you have images that you don't want to be available on the internet, you can put them inside the folder "wiki/img/" for example "testfile.png", now you can link to "/wiki/img/testfile.png"
It's possible to use latex syntax inside your markdown because the markdown is first converted to latex and after that to html. This means you have a lot more flexibility.
{width="50%"}
{#fig:mountain width="50%"}
Inside picture @fig:mountain you can see a nice mountain.
\begin{align}
y(x) &= \int_0^\infty x^{2n} e^{-a x^2}\,dx\\
&= \frac{2n-1}{2a} \int_0^\infty x^{2(n-1)} e^{-a x^2}\,dx\\
&= \frac{(2n-1)!!}{2^{n+1}} \sqrt{\frac{\pi}{a^{2n+1}}}\\
&= \frac{(2n)!}{n! 2^{2n+1}} \sqrt{\frac{\pi}{a^{2n+1}}}
\end{align}
You can also use $inline$ math to show $a=2$ and $b=8$
Open the wiki folder of your instance.
|- static
|- templates
|- wiki <--This folder
|- wiki.py
In this folder all the markdownfiles are listed. Editing the files will be visible in the web-version.
|- homepage.md
|- How to use the wiki.md
|- Markdown cheatsheet.md
The advantage is that u can use the commandline to process some data. For example using pandoc:
pandoc -f markdown -t latex homepage.md How\ to\ use\ the\ wiki.md -o file.pdf --pdf-engine=xelatex
This creates a nice pdf version of your article. Its possible you have to create a yml header on top of your document to set the margins etc better
---
title: titlepage
author: your name
date: 05-11-2020
geometry: margin=2.5cm
header-includes: |
\usepackage{caption}
\usepackage{subcaption}
lof: true
---
For more information you have to read the pandoc documentation.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent