|
1 | 1 | # Stash-Docs |
| 2 | + |
2 | 3 | Website: https://docs.stashapp.cc |
3 | 4 |
|
4 | | -## Join Our Community |
| 5 | +## Community support |
5 | 6 |
|
6 | | -We are excited to announce that we have a new home for support, feature requests, and discussions related to Stash and its associated projects. Join our community on the [Discourse forum](https://discourse.stashapp.cc) to connect with other users, share your ideas, and get help from fellow enthusiasts. |
| 7 | +- **Forum:** [discourse.stashapp.cc](https://discourse.stashapp.cc) - Primary place for community support, feature requests, and discussions. |
| 8 | +- **Discord:** [discord.gg/2TsNFKt](https://discord.gg/2TsNFKt) - Real-time chat and community support. |
| 9 | +- **Lemmy:** [discuss.online/c/stashapp](https://discuss.online/c/stashapp) - Community discussions. |
7 | 10 |
|
8 | 11 | ## Contributing |
9 | 12 |
|
10 | 13 | Everyone is welcome to help with the documentation. All changes are managed through pull requests. |
11 | 14 |
|
12 | 15 | Read step-by-step guide on how to create a pull request [CONTRIBUTING.md](CONTRIBUTING.md). |
13 | 16 |
|
14 | | -## Running locally with pip |
| 17 | +## Local development |
15 | 18 |
|
16 | 19 | ### Prerequisites |
17 | 20 |
|
18 | | -- Python modules |
19 | | - - `mkdocs-material=="9.*"` |
20 | | - - `mkdocs-git-revision-date-localized-plugin` |
21 | | - - `mkdocs-git-committers-plugin-2` |
22 | | - - `mkdocs-glightbox` |
23 | | - - `mkdocs-material[imaging]` |
24 | | - - `mkdocs-redirects` |
25 | | - - 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` |
26 | | -- Clone/download the repository |
| 21 | +- Python modules: |
| 22 | + - `mkdocs-material=="9.*"` |
| 23 | + - `mkdocs-git-revision-date-localized-plugin` |
| 24 | + - `mkdocs-git-committers-plugin-2` |
| 25 | + - `mkdocs-glightbox` |
| 26 | + - `mkdocs-material[imaging]` |
| 27 | + - `mkdocs-redirects` |
| 28 | + |
| 29 | +Install all dependencies with: |
| 30 | + |
| 31 | +```bash |
| 32 | +pip install mkdocs-material=="9.*" mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-glightbox "mkdocs-material[imaging]" mkdocs-redirects |
| 33 | +``` |
27 | 34 |
|
28 | 35 | ### Building the site |
29 | | -1. Open Terminal/Command Prompt and go to your directory where you saved the copy of the repository |
| 36 | + |
| 37 | +1. Open command-line interface and go to your directory where you saved the copy of the repository |
30 | 38 | 2. Run `mkdocs serve` |
31 | 39 |
|
32 | 40 | ## License |
33 | 41 |
|
34 | | -The documentation site is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. |
| 42 | +The documentation site is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. |
0 commit comments