Skip to content

Commit

Permalink
Merge pull request #88 from Global-Tags/docs/improvements
Browse files Browse the repository at this point in the history
docs: Improve docs
  • Loading branch information
RappyTV authored Oct 1, 2024
2 parents 37da41d + bf5d76f commit 7433da1
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- uses: actions/setup-python@v2
with:
python-version: 3.x
Expand Down
22 changes: 20 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
site_name: GlobalTags Documentation
repo_name: Global-Tags/API
repo_url: https://github.com/Global-Tags/API
edit_uri: https://github.com/Global-Tags/API/tree/master/docs/
edit_uri: tree/master/docs/

nav:
- Home: index.md
Expand Down Expand Up @@ -32,6 +32,16 @@ markdown_extensions:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji

plugins:
- search
- git-committers:
enabled: !ENV [CI, false]
repository: Global-Tags/API
branch: master
- git-revision-date-localized:
enabled: !ENV [CI, false]
enable_creation_date: true

theme:
name: material
font:
Expand All @@ -45,6 +55,7 @@ theme:
- content.code.copy
- content.tabs.link
- navigation.expand
- navigation.footer
- search.share
palette:
# Palette toggle for dark mode
Expand All @@ -67,4 +78,11 @@ extra_css:

extra:
generator: false
homepage: https://www.globaltags.xyz
homepage: https://www.globaltags.xyz
social:
- icon: fontawesome/brands/discord
link: https://globaltags.xyz/discord
name: GlobalTags Server
- icon: fontawesome/brands/github
link: https://github.com/Global-Tags
name: GlobalTags on GitHub
35 changes: 35 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
babel==2.16.0
certifi==2024.8.30
charset-normalizer==3.3.2
click==8.1.7
colorama==0.4.6
ghp-import==2.1.0
gitdb==4.0.11
GitPython==3.1.43
idna==3.10
Jinja2==3.1.4
Markdown==3.7
MarkupSafe==2.1.5
mergedeep==1.3.4
mkdocs==1.6.1
mkdocs-get-deps==0.2.0
mkdocs-git-committers-plugin-2==2.3.0
mkdocs-git-revision-date-localized-plugin==1.2.9
mkdocs-material==9.5.39
mkdocs-material-extensions==1.3.1
packaging==24.1
paginate==0.5.7
pathspec==0.12.1
platformdirs==4.3.6
Pygments==2.18.0
pymdown-extensions==10.11.2
python-dateutil==2.9.0.post0
pytz==2024.2
PyYAML==6.0.2
pyyaml_env_tag==0.1
regex==2024.9.11
requests==2.32.3
six==1.16.0
smmap==5.0.1
urllib3==2.2.3
watchdog==5.0.3

0 comments on commit 7433da1

Please sign in to comment.