https://github.com/cmaughan/third-brain

Site Upgrade
https://github.com/cmaughan/third-brain

Last synced: 25 days ago
JSON representation

Site Upgrade

• Host: GitHub
• URL: https://github.com/cmaughan/third-brain
• Owner: cmaughan
• License: cc0-1.0
• Created: 2022-10-18T11:39:23.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-04T00:15:11.000Z (3 months ago)
• Last Synced: 2024-08-04T02:27:18.690Z (3 months ago)
• Language: Markdown
• Size: 492 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: 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/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 `content/index.yaml` to use your site's title (and set the same in `content/index.md`) and a suitable edit URL.

1. Start adding notes to `./content` (where all notes should live).

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 [demo](https://emanote.srid.ca/demo) 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`.