Skip to content

Commit

Permalink
Add mike deployment instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
BradHacker committed Mar 8, 2024
1 parent d4c796c commit 355e4e7
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,25 @@ To build the site locally, just run `mkdocs build` and the static site will be g

## Deployment

The site is automatically built and deployed via GitHub actions.
This site is using versioned documentation with [mike](https://github.com/jimporter/mike).

> ⚠️ To deploy a new version, **merge all changes into `main` first**
```shell
git switch main

mike deploy -t "x.x (latest)" x.x latest

mike serve

# Check to ensure generated site is good to go

git switch gh-pages

git push

git switch main
```

## Development

Expand Down

0 comments on commit 355e4e7

Please sign in to comment.