Silicon Witchery Docs - Source

This site is built with Jekyll and Just the Docs. It's all hosted here on GitHub using the GitHub's Pages feature.

If you spot any errors in our documentation, feel free to make an issue.

If you'd like to make extensive edits, you can also clone this repository locally and view the pages live while editing.

Running locally

This project uses Nix to provide a reproducible toolchain. It works on NixOS, Linux and MacOS.

1. On NixOS, simply add programs.direnv.enable = true; to your configuration.nix.

2. On Linux/MacOS setup Nix:

   sh <(curl --proto '=https' --tlsv1.2 -L https://nixos.org/nix/install) --daemon
   nix profile install nixpkgs#direnv --extra-experimental-features nix-command --extra-experimental-features flakes
   echo 'eval "$(direnv hook zsh)"' >> $ZDOTDIR/.zshrc
   exec zsh

3. Clone this repository:

   git clone git@github.com:siliconwitchery/docs.git

4. Enable direnv:

   cd docs
   direnv allow

5. Start the live server:

   start

6. Open http://localhost:4000. The site rebuilds and refreshes your browser automatically as you edit.