README.md

Browseable Zig standard library 2

This is a little Ruby program that creates a browseable HTML mini-site from the Zig standard library source.

The style was inspired by (as in, nearly identical to) docco.coffee (archive.org).

To make it browseable, @import() calls get converted to hyperlinks.

Run it!

The Ruby program generates a page for one Zig file at a time.

There’s a Bash script to make the whole site.

The first parameter of the script must be a path to a Zig Std Lib (ending in trailing slash /):

./build.sh /home/dave/zig/lib/std/

The second parameter can be a wildcard match of files/directories to generate:

./build.sh /home/dave/zig/lib/std/ queue
atomic/queue.zig
priority_queue.zig
priority_dequeue.zig

Output will be generated in a new directory named output/ in the current working directory.

I don’t need Bash here. Ruby can do all of this. I was just re-using script.
Make an index page with big “browse” link at top followed by semi-automated, categorized file tree