Tips on setting up GitHub pages action

[vcavallo]

Some tips on Configuring the GitHub Pages Action

(From someone who just stumbled through it for hours)

GITHUB_TOKEN Settings

Make sure your (implicitly created) GITHUB_TOKEN has the proper privileges in Repo Settings > Actions > General.

Pages Settings

In Repo Settings > Pages, you may need to make sure "Deploy from branch" is properly set (the gh-pages branch will be created after the emanote action runs at least once) and your custom CNAME domain is set (if using):

Other

• in .github/workflows/publish.yml make sure your cname entry is set (if using a custom domain)
• set the baseUrl property correctly in flake.nix (see below for an example)
• if your site has broken links and you'd like to deploy it that way, adjust the emanote flags in in flake.nix to include allowBrokenLinks:

        emanote = {
          sites."default" = {
            layers = [ ./. ];
            layersString = [ "." ];
            baseUrl = "/"; 
            allowBrokenLinks = true; # HERE!
          };

[srid]

Nice! Would you like to open a PR adding a new page to the docs?

[srid]

Another way: srid/emanote-template#81