https://github.com/potocpav/zettelkasten

Personal notes
https://github.com/potocpav/zettelkasten

Last synced: 15 days ago
JSON representation

Personal notes

• Host: GitHub
• URL: https://github.com/potocpav/zettelkasten
• Owner: potocpav
• License: cc0-1.0
• Created: 2023-02-07T09:20:13.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-30T12:31:27.000Z (6 months ago)
• Last Synced: 2024-11-07T05:36:24.919Z (2 months ago)
• Language: Markdown
• Size: 1.25 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: .github/README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Web: https://potocpav.github.io/zettelkasten/

# 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

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 lock --update-input 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`.