diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml new file mode 100644 index 0000000..e68e7e0 --- /dev/null +++ b/.github/workflows/deployment.yml @@ -0,0 +1,33 @@ +name: Deploy to GitHub Pages + +on: + push: + branches: + - prod + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on + +jobs: + deploy: + name: Deploy to GitHub Pages + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 18 + cache: yarn + + - name: Install dependencies + run: yarn install --frozen-lockfile + - name: Build website + run: yarn build + + # Popular action to deploy to GitHub Pages: + # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.TOKEN }} + # Build output to publish to the `gh-pages` branch: + publish_dir: ./build diff --git a/CNAME b/CNAME new file mode 100644 index 0000000..6ce8871 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +docs.terrarium.earth \ No newline at end of file diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..6ce8871 --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +docs.terrarium.earth \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 6e3d9d7..3b5391a 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -19,9 +19,10 @@ const config = { // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. organizationName: 'terrarium-earth', // Usually your GitHub org/user name. - projectName: 'terrarium-docs', // Usually your repo name. + projectName: 'project-odyssey', // Usually your repo name. + trailingSlash: false, - onBrokenLinks: 'throw', + onBrokenLinks: 'warn', onBrokenMarkdownLinks: 'warn', // Even if you don't use internalization, you can use this field to set useful