Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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
- Host: GitHub
- URL: https://github.com/jacobcrabill/doczy
- Owner: JacobCrabill
- Created: 2024-11-26T02:40:14.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-15T22:29:42.000Z (about 1 month ago)
- Last Synced: 2024-12-15T23:24:06.715Z (about 1 month ago)
- Topics: zig, zig-package
- Language: Zig
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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
```