Repo for https://docs.saltbox.dev
Contributing
- Fork this repo.
- Make your changes and/or additions.
- Open a pull request.
Previewing docs locally
Basic previewing [some things may not preview accurately]:
git clone https://github.com/saltyorg/docs
cd docs
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-materialDocs will be accessible at http://localhost:8000
Full previewing:
The docs are actually built with a different release of mkdocs-material, so to preview them as they will appear when deployed you will need to be added to a private repo and do some local setup to enable the previewing. Contact chazlarson through the Saltbox discord if you're interested in that.
