mdbrowser
| Crates.io | mdbrowser |
| lib.rs | mdbrowser |
| version | 0.5.0 |
| source | src |
| created_at | 2021-05-31 11:31:17.093466 |
| updated_at | 2021-07-28 09:25:04.169803 |
| description | A small tool for browsing markdown files. |
| homepage | |
| repository | |
| max_upload_size | |
| id | 404186 |
| size | 51,253 |
Yao Zongyou (yaozongyou)
documentation
README
mdbrowser
This is a simple tool to render markdown docs. You can specify the style with --style flag. You can also specify a different listening address with the -l flag. Run --help for more options.
Example
- Running with GitHub Markdown style:
./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;}"
This will run a local web server on port 8080 that points to your markdown directory.
- Running with gitiles style:
./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;}"