MDwiki笔记

MDwiki

MDwiki是一套简单的wiki系统,基于markdown文件,运行于客户端(HTML5/Javascript)。所以,本地运行或上传到github都很方便。

需求

如何使用

自定义导航

在wiki目录下创建两个文件,navigation.mdconfig.json,分别实现顶部导航,和页面侧边导航。示例如下:

navigation.md

# Your wiki name

[Home](index.md)
[About](about.md)
[Download](download.md)

config.json

{
    "useSideMenu": true,
    "lineBreaks": "gfm",
    "additionalFooterText": "All content and images © by John Doe",
    "anchorCharacter": "#"
}

基于python的服务器

在linux下可以方便的使用python的内置服务器,建立一个脚本run.sh并增加运行权限:

#!/bin/bash

python3 makeindex.py
xdg-open http://localhost:8000
python3 -m http.server

每次双击脚本,就可以打开浏览器并查看wiki。

windonws下可以建立 run.bat

python makeindex.py
python -m http.server

path=%path%, "C:\Program Files (x86)\Google\Chrome\Application\chrome.exe"
start chrome http://127.0.0.1:8000

自动生成文件索引

可以通过简单的python脚本,实现所有markdown文件的索引页。


更新时间:20181015

参考文档