Skip to content

Commit

Permalink
chore: output docs to gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
RebeccaStevens committed Feb 19, 2023
1 parent f1f18b4 commit b700399
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/release-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ jobs:

- name: tar the existing docs
run: |
mkdir -p ./docs
tar -cvf old-docs.tar ./docs
mkdir -p ./gh-pages
tar -cvf old-docs.tar ./gh-pages
- name: create a document artifact
uses: actions/upload-artifact@v3
Expand All @@ -49,13 +49,13 @@ jobs:
- name: Checkout src
uses: actions/checkout@v3

- run: mkdir -p ./docs
- run: mkdir -p ./gh-pages
- name: Download the existing documents artifact
uses: actions/download-artifact@v3
with:
name: old-docs

- run: tar -xf old-docs.tar ./docs -C ./docs
- run: tar -xf old-docs.tar ./gh-pages -C ./gh-pages

- uses: actions/setup-node@v3
with:
Expand All @@ -70,7 +70,7 @@ jobs:
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: docs/
path: ./gh-pages

- name: Deploy to GitHub Pages
id: deployment
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
coverage/
docs/
gh-pages/
lib/
node_modules/
2 changes: 1 addition & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"excludePrivate": true,
"hideGenerator": true,
"includeVersion": true,
"out": "./docs",
"out": "./gh-pages",
"plugin": [
"typedoc-plugin-coverage",
"typedoc-plugin-mdn-links",
Expand Down

0 comments on commit b700399

Please sign in to comment.