Stash-Docs

Website: https://docs.stashapp.cc

Community support

Forum: discourse.stashapp.cc - Primary place for community support, feature requests, and discussions.
Discord: discord.gg/2TsNFKt - Real-time chat and community support.
Lemmy: discuss.online/c/stashapp - Community discussions.

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.

Local development

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 dependencies with:

pip install mkdocs-material=="9.*" mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-glightbox "mkdocs-material[imaging]" mkdocs-redirects

Building the site

Open command-line interface and go to your directory where you saved the copy of the repository
Run mkdocs serve

License

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

1.3 KiB Raw Permalink Blame History