A template repository to create your own Markdown-based Emanote notebook with Visual Studio Code support, as well as to publish it to GitHub Pages.
See https://emanote.srid.ca/resources/emanote-template for details.
Click the "Use this template" green button on Github, and in the resulting repository make the following modifications,
- Change
content/index.yaml
to use your site's title (and set the same incontent/index.md
) and a suitable edit URL. - Start adding notes to
./content
(where all notes should live).
If deploying using GitHub Pages, also:
- Change
.deploy/github/index.yaml
to change thebaseUrl
(if your repository is named differently or you are using a CNAME). If you are using CNAME (with no sub-path), then you may get rid of the.deploy/github
layer entirely (be sure to update.github/workflows/publish.yaml
accordingly).
Checkout examples and demo for next steps.
To start the Emanote live server using Nix:
# If you using VSCode, you can also: Ctrl+Shift+B
nix run
To update Emanote version in flake.nix:
nix flake lock --update-input emanote
To build the static website via Nix:
nix build -o ./result
# Then test it:
nix run nixpkgs#nodePackages.live-server -- ./result
GitHub Actions CI is responsible for deploying to GitHub Pages. See .github/workflows/publish.yaml
.
The Github Actions jobs relies on Docker. For a purely Nix based approach, see https://github.com/srid/srid/blob/master/.github/workflows/publish.yaml