A template repository to create your own Markdown-based Emanote notebook with VSCode 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
) - Set a suitable edit URL in
content/templates/hooks/after-note.tpl
- 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 updatepublish.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
Two forms of CI are provided:
- GitHub Actions/Pages: see
.github/workflows/publish.yaml
- Hercules CI via Nix: see
*.nix