有时候我们写的文档,想要发布到公网或局域网上,分享给他人。当你不想花时间在纠结怎么搭建网站,下载各种依赖等等。那么 Librarian 也许可以帮到你。Librarian 可以一键启动一个 markdown 站点,你只需要写好 markdown 文档,以及设置目录yml。
github地址:https://github.com/GoAdminGroup/librarian
使用
下载Librarian
文件名 | 系统 | 系统架构 | 大小 |
---|---|---|---|
librarian_darwin_x86_64_v0.0.2.zip | macOS | x86-64 | 11.1 MB |
librarian_linux_x86_64_v0.0.2.zip | Linux | x86-64 | 14.6 MB |
librarian_linux_armel_v0.0.2.zip | Linux | x86 | 13.9 MB |
librarian_windows_i386_v0.0.2.zip | Windows | x86 | 14.1 MB |
librarian_windows_x86_64_v0.0.2.zip | Windows | x86-64 | 14.5 MB |
设置数据库
下载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
可以看到:
关于 librarian 更多命令行参数,可以执行:
./librarian --help
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。