Skip to content

Commit e9350b1

Browse files
authored
Retire builder (#118)
1 parent 086bff9 commit e9350b1

39 files changed

+25
-1373
lines changed

.github/workflows/mkdocs-ci.yml

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,8 @@ permissions:
1313

1414
jobs:
1515
deploy:
16-
if: github.repository == 'stashapp/Stash-Docs' # Replace with your repository details
16+
if: github.repository == 'stashapp/Stash-Docs'
1717
runs-on: ubuntu-latest
18-
env:
19-
BUILDER_GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2018

2119
steps:
2220
- uses: actions/checkout@v4
@@ -32,25 +30,13 @@ jobs:
3230
with:
3331
python-version: 3.x
3432

35-
- uses: actions/setup-node@v4
36-
37-
- name: "Builder setup"
38-
run: |
39-
npm i
40-
npm i -g ts-node
41-
cd builder
42-
mkdir dist dist/plugins dist/themes
43-
ts-node build.ts
44-
cp dist/plugins/* ../docs/plugins/list.md
45-
cp dist/themes/* ../docs/themes/list.md
46-
47-
- run: pip install \
33+
- run: pip install \
4834
mkdocs-material=="9.*" \
4935
mkdocs-rss-plugin \
5036
mkdocs-git-revision-date-localized-plugin \
5137
mkdocs-git-committers-plugin-2 \
5238
mkdocs-glightbox \
5339
mkdocs-material[imaging] \
5440
mkdocs-redirects
55-
41+
5642
- run: mkdocs gh-deploy --force

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,42 @@
11
# Stash-Docs
2+
23
Website: https://docs.stashapp.cc
34

4-
## Join Our Community
5+
## Community support
56

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.
710

811
## Contributing
912

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

1215
Read step-by-step guide on how to create a pull request [CONTRIBUTING.md](CONTRIBUTING.md).
1316

14-
## Running locally with pip
17+
## Local development
1518

1619
### Prerequisites
1720

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+
```
2734

2835
### 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
3038
2. Run `mkdocs serve`
3139

3240
## License
3341

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.

builder/build.ts

Lines changed: 0 additions & 124 deletions
This file was deleted.

builder/plugin.ts

Lines changed: 0 additions & 100 deletions
This file was deleted.

builder/repositories/example.yml

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)