Custom Domain Name

If you are wanting to use your own domain name, follow the GitHub documentation about custom domains and GitHub Pages.

Github Actions

If you are using GitHub Pages with GitHub Actions, you can add the cname to the workflow file.

The workflow YAML includes a commented out value, cname, at the very bottom of the configuration. You can uncomment this line, and use your own domain name as so.

    - name: Deploy site
      uses: peaceiris/actions-gh-pages@v3
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_branch: pages
        publish_dir: docs/
        force_orphan: true


Ensure that your siteUrl is adjusted properly in dendron.yml:

  • NOTE: When using custom domain names, assetsPrefix isn't required like it otherwise would be with GitHub Pages. Remove assetsPrefix if it is present in your dendron.yml, otherwise the website may not load as expected.