Repository files navigation

Website forZig.

We useZine for static site generation.

Zine, and the Zig website itself (when it comes to code samples), target the latest tagged release of Zig.

For a convenient way of juggling multiple versions of Zig, take a look atzigup.

Once you have the correct version of Zig setup, simply run:

zig build serve

This step is optional but highly recommended.

Followthe instructions on the official Zine website.

Following this step will give you syntax highlighting and LSP support for the templating language.

Some code examples present on the site require some basic system dependencies:

• tar
• zlib
• jq

It should be possible to get them on all major OSs although on Windows it might be easier to just use WSL.If you know how to get all dependencies on Windows please PR some instructions!

Seethe Zine documentation to learn more about content and templating syntax.

After you've familiarized yourself with the basics, take a look atthe i18n section of the docs.

To recap, a translation needs to:

• be listed inbuild.zig and have its corresponding content directory created
• have a corresponding Ziggy file underi18n/, containing the localized version of every phrase used throughout the site
• have all content files translated, with the exception ofnews anddevlog that should not be translated

Crafting a translation is not a straight-forward process. You have to think about adaptation, spatial constraints (in the front page especially), and other Zine-specific issues that might not be immediately obvious.

If you don't mind instant messaging, please consider joining one of theZig communities, where you will be able to communicate with other contributors and share some knowledge.

If you prefer asynchronous communication, feel free to open a draft PR, we will make sure to engage with you pronto.

Keep in mind that it's possible that the current setup doesn't allow you to correctly implement a translation without making ulterior changes to Zine's configuration or how the content is organized. Don't hesitate to reach out for help to avoid getting stuck in a problem that can't be solved without larger-scale changes.