Stash-Docs

Website: https://docs.stashapp.cc

Contributing

Everyone is welcome to help with the documentation. All changes are managed through pull requests.

Read step-by-step guide on how to create a pull request CONTRIBUTING.md.

Running locally with pip

Prerequisites

• Python modules
  • mkdocs-material=="9.*"
  • mkdocs-git-revision-date-localized-plugin
  • mkdocs-git-committers-plugin-2
  • mkdocs-glightbox
  • mkdocs-material[imaging]
  • mkdocs-redirects
  • Install all with pip install mkdocs-material=="9.*" mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-glightbox mkdocs-material[imaging] mkdocs-redirects
• Clone/download the repository

Building the site

1. Open Terminal/Command Prompt and go to your directory where you saved the copy of the repository
2. Run mkdocs serve

License

The documentation site is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.