Skip to main content

Configurations in the Docusaurus implementation for this website

Docusaurus local config files​

In the config object in the following file as the values as shown

/docusaurus.config.js

  // Set the production url of your site here
  url: 'https://kb.greyling.tech',
  // Set the /<baseUrl>/ pathname under which your site is served
  // For GitHub pages deployment, it is often '/<projectName>/'
  baseUrl: '/kb/',

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: 'marcg1968', // Usually your GitHub org/user name.
  projectName: 'kb', // Usually your repo name.
  trailingSlash: false,
  deploymentBranch: 'gh-pages',

and in the /.github/ directory the following two files need to be defined:

/.github/workflows/deploy.yml
name: Deploy to GitHub Pages

on:
  push:
    branches:
      - master
    # 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: 16
          cache: npm

      - name: Install dependencies
        run: npm ci
      - name: Build website
        run: npm run 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.GITHUB_TOKEN }}
          # Build output to publish to the `gh-pages` branch:
          publish_dir: ./build
          # The following lines assign commit authorship to the official
          # GH-Actions bot for deploys to `gh-pages` branch:
          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
          # The GH actions bot is used by default if you didn't specify the two fields.
          # You can swap them out with your own user credentials.
          #user_name: github-actions[bot]
          #user_email: 41898282+github-actions[bot]@users.noreply.github.com
          user_name: marcg1968
          user_email: mgreyling@gmail.com
/.github/workflows/test-deploy.yml
name: Test deployment

on:
  pull_request:
    branches:
      - master
    # 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:
  test-deploy:
    name: Test deployment
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 19
          cache: npm

      - name: Install dependencies
        run: npm ci
      - name: Test build website
        run: npm run build

GitHub settings​

The repository name is kb, corresponding to the value for the key baseUrl and projectName, above.

Under the [Settings] section of the repository in Github, go to [Actions] > [General] and under [Workflow permissions] set the option to

(o) Read and write permissions

Workflows have read and write permissions in the repository for all scopes.

References​