Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jacobcrabill/doczy

Doczy: Markdown Documentation Browser
https://github.com/jacobcrabill/doczy

zig zig-package

Last synced: about 1 month ago
JSON representation

Doczy: Markdown Documentation Browser

Awesome Lists containing this project

README

        

# Doczy: Markdown Documentation Browser

> Instantly view your Markdown docs in the browser!

Looking for a better way to browse your Markdown docs quickly and easily without jumping through the
hoops of setting up [mdBook](https://rust-lang.github.io/mdBook/),
[Sphinx](https://www.sphinx-doc.org/en/master/), or some other toolchain?

Use **Doczy!**

Navigate to the [test documentation index](docs/index.md) for an example.

Powered by Zig ![zig-zero](docs/imgs/zig-zero.png)

## Usage Example

```bash
zig build -Doptimize=ReleaseSmall
./zig-out/bin/doczy -f README.md
```