Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hcorion/notes-emanote
https://github.com/hcorion/notes-emanote
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hcorion/notes-emanote
- Owner: hcorion
- License: cc0-1.0
- Created: 2022-02-17T05:11:52.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-17T00:33:28.000Z (about 1 month ago)
- Last Synced: 2024-11-17T01:23:46.032Z (about 1 month ago)
- Language: Markdown
- Size: 929 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: .github/README.md
- License: LICENSE
Awesome Lists containing this project
README
# emanote-template
A template repository to create your own Markdown-based [Emanote](https://github.com/srid/emanote) notebook with [Visual Studio Code](https://code.visualstudio.com/) support, as well as to publish it to GitHub Pages.
See https://emanote.srid.ca/start/resources/emanote-template for details.
## Using this template
Click the "Use this template" green button on Github, and in the resulting repository make the following modifications,
1. Change `index.yaml` to use your site's title (and set the same in `index.md`) and a suitable edit URL.
1. Start adding `.md` notes at repository root (you can use VSCode or [Obsidian](https://obsidian.md/))
If deploying using GitHub Pages, also:
1. Change `flake.nix` to set the `baseUrl` (if your repository is named differently or you are using a CNAME).
Checkout [examples](https://emanote.srid.ca/examples) and [guide](https://emanote.srid.ca/guide) for next steps.
## Running using Nix
To start the Emanote live server using Nix:
```sh
# If you using VSCode, you can also: Ctrl+Shift+B
nix run
```
To update Emanote version in flake.nix:
```sh
nix flake update emanote
```
To build the static website via Nix:
```sh
nix build -o ./result
# Then test it:
nix run nixpkgs#nodePackages.live-server -- ./result
```
## GitHub Pages
GitHub Actions CI is responsible for deploying to GitHub Pages. See `.github/workflows/publish.yaml`.