/docs

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

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
Chaz Larson
salty/
salty
Max
Max Kowalski
grostim/
grostim
owine/
owine
Turbo/
Turbo
keldian/
keldian
James
James Shopland
JohnClementine/
JohnClementine
stayupthetree/
stayupthetree
CGH/
CGH
JigSaw/
JigSaw
Kyle
Kyle Mohr
Sully/
Sully
iDoMnCi/
iDoMnCi
phob/
phob
thatsnasty/
thatsnasty
xplorer990/
xplorer990
~tipdec-siblyn/
~tipdec-siblyn
ハックモンカー/
ハックモンカー