Skip to content

Commit

Permalink
Update CI
Browse files Browse the repository at this point in the history
Add new plugins
Introduce footnotes
  • Loading branch information
DogmaDragon committed Feb 7, 2024
1 parent 786121a commit 3c22638
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,6 @@ jobs:
mkdocs-material \
mkdocs-rss-plugin \
mkdocs-git-revision-date-localized-plugin \
mkdocs-git-committers-plugin-2
mkdocs-git-committers-plugin-2 \
mkdocs-glightbox
- run: mkdocs gh-deploy --force
10 changes: 7 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ hide:

## What is FansDB?

FansDB is user-curated metadata database focused on individual adult content creators. It runs on [stash-box](https://github.com/stashapp/stash-box){target=_blank} which takes advantage of perceptual hashing to make matching your existing files to metadata stored on FansDB super easy, barely an inconvenience.
FansDB is user-curated metadata database focused on individual adult content creators. It runs on stash-box[^1] which takes advantage of perceptual hashing to make matching your existing files to metadata stored on FansDB super easy, barely an inconvenience.

To make the most of it you should also install a local adult content organizer called [Stash](https://github.com/stashapp/stash){target=_blank} developed by the same team. Follow their [documentation](https://docs.stashapp.cc/getting-started/){target=_blank} to get started.
To make the most of it you should also install a local adult content organizer called Stash[^2] developed by the same team. Follow their documentation[^3] to get started.

## Guidelines

Expand All @@ -28,4 +28,8 @@ To make the most of it you should also install a local adult content organizer c
4. While logged in click on your username at the top of the menu bar and find an **API key** and **GraphQL Endpoint** sections.
5. Go to your local Stash and go to `Settings` > `Metadata Providers` > `Stash-box Endpoints` > `Add`.
6. Enter the **Name**, **GraphQL endpoint**, **API key** and click `Confirm`. You can also click `Test Credentials` to make sure everything is correct.
7. The endpoint is now added and can be used to scrape metadata like with any other scraper.
7. The endpoint is now added and can be used to scrape metadata like with any other scraper.

[^1]: [stash-box repository](https://github.com/stashapp/stash-box){target=_blank}
[^2]: [Stash repository](https://github.com/stashapp/stash){target=_blank}
[^3]: [Stash documentation](https://docs.stashapp.cc/getting-started/){target=_blank}
16 changes: 14 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,26 +76,38 @@ plugins:
repository: FansDB/docs
branch: main
enabled: !ENV [CI, false]
# - social:
# cards_layout: default/variant
- glightbox
- social:
enabled: !ENV [CI, false]
cards_layout: default/variant

watch:
- includes

markdown_extensions:
- attr_list
- md_in_html
- abbr
- admonition
- pymdownx.details
- pymdownx.superfences
- footnotes
- tables
- pymdownx.snippets:
auto_append:
- includes/abbreviations.md
- toc:
permalink: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
- Home: index.md
Expand Down

0 comments on commit 3c22638

Please sign in to comment.