-
-
Notifications
You must be signed in to change notification settings - Fork 521
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: create docs with docosaurus (#659)
* chore: create docs with docosaurus * ci: update docs workflow * chore: remove api folder in docs folder * chore: update avatar sizes in readme * chore: improve typedoc * chore: remove tt.tsx
- Loading branch information
1 parent
4b13041
commit dfbbd31
Showing
23 changed files
with
8,916 additions
and
1,029 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
github: [oblador, vonovak] | ||
github: [oblador, vonovak, DorianMazur] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
name: Docs | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
pull_request: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
build: | ||
name: Build Docusaurus | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version-file: .nvmrc | ||
- name: Enable corepack | ||
run: corepack enable | ||
- name: Install dependencies | ||
run: yarn install --immutable | ||
- name: Build website | ||
working-directory: ./website | ||
run: yarn build | ||
- name: Upload Build Artifact | ||
if: github.ref_name == 'master' | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: website/build | ||
|
||
deploy: | ||
name: Deploy to GitHub Pages | ||
needs: build | ||
runs-on: ubuntu-latest | ||
if: github.ref_name == 'master' | ||
|
||
permissions: | ||
pages: write | ||
id-token: write | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.