ziglang / www.ziglang.org

https://ziglang.org/
MIT License
281 stars 168 forks source link
documentation zig

ziglang.org

Website for Zig

How to run locally

We use Zine for static site generation.

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

For a convenient way of juggling multiple version of Zig, take a look at zigup.

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

zig build serve

Get editor support

This step is optional but highly recommended.

Follow the instructions on the official Zine website.

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

Writing a translation

See the Zine documentation to learn more about content and templating syntax.

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

To recap, a translation needs to:

Getting help

Crafting a translation is not a straight-forward proceess. 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 the Zig 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 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.