Generated std lib docs for offline use

Help
1

i’ve found a libs/doc/index.html file in a recent download, and tried to launch this file in my browser…

i see the main banner as well as a Loading ... message – but that’s all…

is there any form of the lib docs that i can use offline??? (i already know about langref.html)…

FWIW – i’m heading to embedded world in europe next week, and want to play in my zig sandbox when in the air  :airplane:

2 Likes
2

Related: A new Zig standard library documentation mini-site generator

Not sure if that fits your needs, but I think you can run it locally.

1 Like
3

Those docs need a web server to run, because they’re actually generated dynamically! Running zig std will spin up a local web server and open it in your web browser and you’ll be able to browse the same docs as on Zig Documentation

7 Likes
4

As @Siph said, to open a web browser for the local standard library docs:

zig std

This can take some time to load, because the documentation is generated from the source files.

For your generated docs:

open http://127.0.0.1:8000
python -m http.server -b 127.0.0.1 8000 -d zig-out/docs/
1 Like
5

entering zig std (0.12.0.dev) returns error: FileNotFound

6

definitely can run it locally… search is a challenge :wink:

7

As long as zig std prints the address it’s listening on, you should be able to view the docs by navigating to that address in a browser. It also tries to open your web browser automatically, which might result in printing error: FileNotFound if it can’t find the command to do so, but that won’t affect the core behavior of the server.

1 Like