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

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

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

使用

下载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,并放置于项目文件夹下。github

设置目录

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

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

运行

咱们的文件夹结构以下,docs是放置markdown文档的地方。windows

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

接着咱们执行:bash

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

访问:http://localhost:9055/docsmarkdown

能够看到:架构

image

关于 librarian 更多命令行参数,能够执行:网站

./librarian --help
相关文章
相关标签/搜索