JigSawFr / docs

Repo for https://docs.saltbox.dev

Contributing

1. Fork this repo.
2. Make your changes and/or additions.
3. 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-material

Docs 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.

Contributors

Chaz Larson	salty	Max Kowalski	grostim	Turbo	JohnClementine
keldian	stayupthetree	CGH	James Shopland	Kyle Mohr	Sully
iDoMnCi	thatsnasty	xplorer990	ハックモンカー