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
相關文章
相關標籤/搜索