Wikmd：基于Markdown文件的个人wiki

发表于 更新于 分类于 Waline： 阅读次数： 本文字数： 2k 阅读时长 ≈ 2 分钟
wikmd 是一个基于 Markdown 文件的 wiki。

节后第一更，老苏祝您兔年大吉，幸福安康，事事顺心！

什么是 wikmd ？

wikmd 是一个基于文件的 wiki，旨在简化。这些文档完全用 Markdown 编写，使用 pandoc 将 Markdown 文件转换为 html5。

👇官方的动图演示了软件的基本功能

安装

在群晖上以 Docker 方式安装。

在注册表中搜索 wikmd ，选择第一个 wikmd，版本选择 latest。

卷

在 docker 文件夹中，创建一个新文件夹 wikmd，并在其中建一个子文件夹wiki，需要给 wiki 目录新增 Everyone 的读写权限

文件夹 装载路径 说明
docker/wikmd/wiki /wiki 存放设置

端口

本地端口不冲突就行，不确定的话可以用命令查一下

1
2
# 查看端口占用
netstat -tunlp | grep 端口号
本地端口 容器端口
5151 5000

环境

主要的几个变量说明见下表👇

可变 值
PUID <uid> 设为 1000
PGID <gid> 设为 1000
TZ 系统时区设置，设置为 Asia/Shanghai
HOMEPAGE 指定用作主页的文件
HOMEPAGE_TITLE 指定主页的标题
WIKMD_LOGGING 启用/禁用文件记录
WIKI_DIRECTORY wiki 数据存储的路径
IMAGES_ROUTE 自定义图片上传路径

更多的环境变量：https://linbreux.github.io/wikmd/environment%20variables.html

命令行安装

如果你熟悉命令行，可能用 docker cli 更快捷

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 新建文件夹 wikmd 和 子目录
mkdir -p /volume2/docker/wikmd/wiki

# 进入 wikmd 目录
cd /volume2/docker/wikmd

# 修改目录权限
chmod 777 wiki

# 运行容器
docker run -d \
  --name wikmd \
  --restart unless-stopped \
  -p 5151:5000 \
  -v $(pwd)/wiki:/wiki \
  -e TZ=Asia/Shanghai \
  -e PUID=1000 \
  -e PGID=1000 \
  -e HOMEPAGE=homepage.md \
  -e HOMEPAGE_TITLE=homepage.md \
  -e WIKMD_LOGGING=1 \
  -e WIKI_DIRECTORY=/wiki \
  linbreux/wikmd:latest

也可以用 docker-compose 安装，将下面的内容保存为 docker-compose.yml 文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
version: "2.1"

services:
    wikmd:
        image: linbreux/wikmd:latest
        container_name: wikmd
        restart: unless-stopped
        volumes:
            - ./wiki:/wiki
        ports:
            - 5151:5000
        environment:
            - PUID=1000
            - PGID=1000
            - TZ=Asia/Shanghai
            - HOMEPAGE=homepage.md
            - HOMEPAGE_TITLE=homepage.md
            - WIKMD_LOGGING=1
            - WIKI_DIRECTORY=/wiki

然后执行下面的命令

1
2
3
4
5
6
7
8
9
10
11
12
13
# 新建文件夹 wikmd 和 子目录
mkdir -p /volume2/docker/wikmd/wiki

# 进入 wikmd 目录
cd /volume2/docker/wikmd

# 修改目录权限
chmod 777 wiki

# 将 docker-compose.yml 放入当前目录

# 一键启动
docker-compose up -d

运行

在浏览器中输入 http://群晖IP:5151 ，太快了会显示错误

要稍等一会儿才能看到主界面

点 New 新建一篇

保存后直接显示渲染的页面

新建的文件保存在 wiki 目录中

老苏上传了一些之前写的 Markdown 文档，目录也是支持的

打开一篇

尝试搜索 heimdall

虽然支持知识图谱，但是因为没有符合双链的文档，所以看起来都是孤立的

参考文档

Linbreux/wikmd: A file based wiki that uses markdown
地址：https://github.com/Linbreux/wikmd

Docker installation - wikmd
地址：https://linbreux.github.io/wikmd/installation/docker.html

markdown wiki - wikmd : selfhosted
地址：https://www.reddit.com/r/selfhosted/comments/t0m0bz/markdown_wiki_wikmd/