Skip to content

Commit

Permalink
Merge pull request #758 from isaacdonaldson/documentation/add_zola_to…
Browse files Browse the repository at this point in the history
…_contributing.md

Add doc site running instructions to CONTRIBUTING.md
  • Loading branch information
kaplanelad authored Sep 19, 2024
2 parents 9a0e0af + 2470659 commit 883be95
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ Updating the Documentation
+ Create the snippet in the [yaml file](./snipdoc.yml) or inline the code.
+ Run `snipdoc run`.

To run the documentation site locally, we use [zola](https://www.getzola.org/) so you'll need to [install](https://www.getzola.org/documentation/getting-started/installation/) it. The documentation site works with zola version `0.19.2` and since zola still has breaking changes, we make no guarantees about other versions.

Running the local preview
+ `cd docs-site`
+ `npm run serve` or `zola serve`

## Open A Pull Request

Expand Down

0 comments on commit 883be95

Please sign in to comment.