Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docgen again. #47

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Docgen again. #47

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db41020
build.zig: render md pages again, add koino dep.
kivikakk Jul 1, 2024
ecd3e18
render-md-page: update for zig 0.13.
kivikakk Jul 1, 2024
4a37889
README: update as there's no submodule, and I ungated it by default a…
kivikakk Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
README: update as there's no submodule, and I ungated it by default a… 
…s the Zig dep isn't optional.
  • Loading branch information
@kivikakk
kivikakk committed Jul 1, 2024
commit 4a378890059c0eeab1c03a9ba303fe806fdfb985
5 changes: 2 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,11 +225,10 @@ This will execute all zig tests, and also runs a set of predefined tests within

### Building the website

The website generator is gated behind `-Denable-website` which removes a lot of dependencies for people not wanting to render a new version of the website.
If you still want to update/change the website or documentation, use the following command:
If you want to update/change the website or documentation, use the following command:

```sh
zig build -Denable-website "-Dversion=$(git describe --tags || git rev-parse --short HEAD)" website
```

It will depend on [koino](https://github.com/kivikakk/koino), which is included as a git submodule. Adding new pages to the documentation is done by modifying the `menu_items` array in `src/tools/render-md-page.zig`.
Adding new pages to the documentation is done by modifying the `menu_items` array in `src/tools/render-md-page.zig`.
Loading