Librarian: 帮你快速一键启动一个markdown站点

有时候我们写的文档,想要发布到公网或局域网上,分享给他人。当你不想花时间在纠结怎么搭建网站,下载各种依赖等等。那么 Librarian 也许可以帮到你。Librarian 可以一键启动一个 markdown 站点,你只需要写好 markdown 文档,以及设置目录yml。

github地址:https://github.com/GoAdminGroup/librarian

使用

下载Librarian

设置数据库

下载librarian.db,并放置于项目文件夹下。

设置目录

设置好目录,编写一个nav.yml,放置于文档文件夹下:

nav:
 - 介绍: README.md
 - 准备工作: installation.md
 - 快速开始: quick_start.md

运行

我们的文件夹结构如下,docs是放置markdown文档的地方。

.
├── docs
│  ├── ...
│  ├── xxx.md
│  └── nav.yml
├── librarian.db
└── librarian

接着我们执行:

./librarian --port=9055 --path=./docs

访问:http://localhost:9055/docs

可以看到:

image

关于 librarian 更多命令行参数,可以执行:

./librarian --help

本文来自:Segmentfault

感谢作者:cg33

查看原文:Librarian: 帮你快速一键启动一个markdown站点

• 编辑
• 预览