Skip to content

Commit

Permalink
Changed: Deploy/dogfood workflow to match Reloaded upstream.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sewer56 committed Feb 21, 2024
1 parent fd5130e commit 8d143e3
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 8 deletions.
11 changes: 9 additions & 2 deletions .github/workflows/DeployMkDocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,16 @@ on:
- "docs/**"

jobs:
build-and-deploy:
build:
runs-on: ubuntu-latest
environment:
name: github-pages
permissions:
contents: read
pages: write
id-token: write
uses: Nexus-Mods/NexusMods.App.Meta/.github/workflows/mkdocs-build-and-deploy.yaml@main
steps:
- name: Deploy MkDocs
uses: Reloaded-Project/reloaded-project-configurations-rust/.github/actions/deploy-mkdocs-documentation@v1
with:
REQUIREMENTS: ./docs/requirements.txt
14 changes: 12 additions & 2 deletions Pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,16 +79,26 @@ nav:
- Add a GitHub Actions workload in `.github/workflows/DeployMkDocs.yml`.

```yaml
name: Deploy MkDocs
name: MkDocs Build and Deploy
on:
workflow_dispatch:
push:
branches: [ main ]
workflow_dispatch:
paths:
- "mkdocs.yml"
- "docs/**"
pull_request:
branches: [ main ]
paths:
- "mkdocs.yml"
- "docs/**"
jobs:
build:
runs-on: ubuntu-latest
environment:
name: github-pages
permissions:
contents: read
pages: write
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mkdocs-redirects
6 changes: 2 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ markdown_extensions:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:mmaterial.extensions.emoji.to_svg
emoji_generator: !!python/name:material.extensions.emoji.to_svg

theme:
name: material
Expand All @@ -53,6 +53,4 @@ nav:
- Home: Pages/index.md
- License: Pages/license.md
- Contributing: Pages/contributing.md
- Testing Zone: Pages/testing-zone.md

index: Pages/index.md
- Testing Zone: Pages/testing-zone.md

0 comments on commit 8d143e3

Please sign in to comment.