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 a Nix flake to provide its toolchain. The flake supports x86-64 Linux only.

1. Install Nix with flakes enabled, and direnv.

2. Clone this repository:

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

3. Enable direnv, which enters the development shell and installs the gems:

   cd docs
   direnv allow

4. Start the live server:

   bundle exec jekyll serve --livereload --port 4001

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