#style #markdown #css #docs #directory #version #toc

app mdbrowser

一个用于浏览markdown文件的轻量级工具

3个版本 (破坏性更新)

0.5.0 2021年7月28日
0.2.0 2021年6月4日
0.1.0 2021年5月31日

#8 in #toc

MIT 许可协议

16KB
311

mdbrowser

这是一个简单的工具,用于渲染markdown文档。您可以使用--style标志指定样式。您还可以使用-l标志指定不同的监听地址。运行--help以获取更多选项。

示例

  1. 使用GitHub Markdown样式运行
./mdbrowser -C /path/to/markdown/directory                                                           \
    --style="https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/4.0.0/github-markdown.css"   \
    --style="body {width: 1024px;margin: 20px auto 20px;}"                                           \
    --style=".toc {margin-bottom: 16px;} .toc-aux {background: #f9f9f9; border: 1px solid #f2f2f2}"  \
    --style=".version {margin-top: -10px; margin-bottom: 16px;}"

这将在一个本地web服务器上运行,端口号为8080,指向您的markdown目录。

  1. 使用gitiles样式运行
./mdbrowser -C /path/to/markdown/directory                                                           \
    --css_class="doc"                                                                                \
    --style="https://chromium.googlesource.com/+static/base.css"                                     \
    --style="https://chromium.googlesource.com/+static/doc.css"                                      \
    --style="body {width: 1024px;margin: 20px auto 20px;}"                                           \
    --style=".toc {margin-bottom: 16px;} .toc-aux {background: #f9f9f9; border: 1px solid #f2f2f2}"  \
    --style=".version {margin-top: -10px; margin-bottom: 16px;}"

依赖项

~22–34MB
~589K SLoC