Skip to content

sec-js/Stash-Docs

 
 

Stash-Docs

Website: https://docs.stashapp.cc

Community support

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

  1. Open command-line interface 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.

About

The documentation maintained by the community for Stash

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 100.0%