Zig Autodoc : render markdown files?

Help
,
1

Hi all, me again, with another autodoc question (#3 I think ^^).

Back in the days, Zig 0.11 I guess, you were able to include whole markdown files which would then be rendered into autodocs, via the !zig-autodoc-guide special comment.

Is that still a thing? The special comment doesn’t seem to work anymore with Zig 0.14 / 0.15 master. I can easily include additional resources such as markdown files into the output directory of the docs via the build system. I can also link them in for example doc comments, but those would not get rendered, just shown as plain text. Which looks… not so nice in the browser :cowboy_hat_face:

2

Currently not a thing, might return in the future. Autodoc was rewritten from scratch and all tentative explorations were dropped in the process, but the concept of supporting guides does make sense so it might return.

As a workaround you might consider embedding generated autodocs into a static website to provide your guides. https://zml.ai does that, for example.

4 Likes
3

Sounds good :slight_smile:

Also, embedding autodocs in a static site sounds like a nice project to try out this Zig tool called zine ^^

3 Likes