Skip to content

Commit

Permalink
Update installation docs for composite action
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkKremer committed Oct 20, 2024
1 parent a93fda8 commit 3576949
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 23 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@ jobs:
id-token: write
env:
DOCS_DIR: 'docs/'
OUTPUT_DIR: '_site/'
BRANCH: 'main'
steps:
- name: Checkout
uses: actions/checkout@v3
- uses: ./
with:
docs-directory: ${{ env.DOCS_DIR }}
output-directory: ${{ env.OUTPUT_DIR }}
main-branch: ${{ env.BRANCH }}
23 changes: 2 additions & 21 deletions docs/01. Getting Started/01. Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,37 +18,18 @@ on:
tags: ['*']

jobs:

upload-docs:
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
env:
DOCS_DIR: 'docs/'
DEST_DIR: '_site/'
BRANCH: 'main'
steps:
- uses: actions/configure-pages@v5
id: configure-pages
- uses: actions/checkout@v3
with:
ref: ${{ env.BRANCH }}
fetch-depth: 0 # checkout a non-shallow copy so the generator can generate docs for all major versions
- uses: gopxl/docs@main
with:
deploy-url: ${{ steps.configure-pages.outputs.base_url }}
docs-directory: ${{ env.DOCS_DIR }}
destination-directory: ${{ env.DEST_DIR }}
- uses: actions/upload-pages-artifact@v3
with:
path: ${{ env.DEST_DIR }}
- uses: actions/deploy-pages@v4
docs-directory: 'docs/'
main-branch: 'main'
```
The `DOCS_DIR` environment variable can be changed to point
to the directory containing the MarkDown files.

## Linking the site from the GitHub repository
Optionally, it's possible to configure the GitHub Pages site as website
Expand Down

0 comments on commit 3576949

Please sign in to comment.