Skip to content

Commit

Permalink
feat(docs): Rebuild doc site with vitepress
Browse files Browse the repository at this point in the history
Summary: Rebuild doc site with vitepress

Reviewed By: cabanier

Differential Revision: D52060868

fbshipit-source-id: fed6e8df4ab641984d74cc3f2b6eeb2b756c7e0a
  • Loading branch information
felixtrz authored and facebook-github-bot committed Dec 12, 2023
1 parent 53aabdd commit b96d9fe
Show file tree
Hide file tree
Showing 28 changed files with 15,839 additions and 422 deletions.
28 changes: 12 additions & 16 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,16 @@
name: Build and deploy docs to Pages
name: Build and Deploy Docs to GitHub Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ['main']

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: 'pages'
group: 'pages-deployment'
cancel-in-progress: true

jobs:
Expand All @@ -34,25 +28,27 @@ jobs:
steps:
- uses: actions/checkout@v3

- name: Use Node.js ${{ matrix.node-version }}
- name: Set up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}

- name: Build library
- name: Build Library
run: npm install && npm run build

- name: Build example
- name: Build Example
run: cd example && npm install && npm run build && cd ..

- name: Build doc site
run: npm run doc
- name: Build Documentation Site
run: npm run docs:build

- name: Move Example Build to Docs
run: mv example/dist/ docs/.vitepress/dist/example

- name: Upload artifact
- name: Upload Artifact for Deployment
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: './docs'
path: ./docs/.vitepress/dist

- name: Deploy to GitHub Pages
id: deployment
Expand Down
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,11 @@
lib/
build/
dist/
docs/
node_modules/

/.vscode/

# blender backups
*.blend?

.DS_Store

ratk-build.tgz
.DS_Store
Loading

0 comments on commit b96d9fe

Please sign in to comment.