Preparing the local environment for writing documentation¶

Getting Started¶

• Contribute: Tutorial
• Markdown: Uses Material for MkDocs

Setup¶

1. Prerequisites:

   • uv: Install via:

     # macOS/Linux
     curl -LsSf https://astral.sh/uv/install.sh | sh
     # Windows
     powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
     

     - graphviz for local deployment,

   • juvix for local deployment,

     curl --proto '=https' --tlsv1.2 -sSfL https://get.juvix.org | sh
     

     - just for local development (although you can use uv run for most commands)

2. Setup Commands:

   just setup-repo
   

Documentation¶

• Build: just build
• Serve Locally: just serve

Development with Nix¶

1. Install Nix: Download
2. Enable Flakes: Guide
3. Enter Shell: nix develop