https://github.com/srid/neuron-template

A template to get started with neuron
https://github.com/srid/neuron-template

markdown neuron static-site zettelkasten

Last synced: 3 months ago
JSON representation

A template to get started with neuron

• Host: GitHub
• URL: https://github.com/srid/neuron-template
• Owner: srid
• Created: 2020-06-27T00:17:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-05-03T01:20:53.000Z (over 2 years ago)
• Last Synced: 2024-10-11T23:50:00.436Z (3 months ago)
• Topics: markdown, neuron, static-site, zettelkasten
• Language: Markdown
• Homepage: https://srid.github.io/neuron-template/
• Size: 2.92 MB
• Stars: 85
• Watchers: 5
• Forks: 19
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# How to publish your own [neuron] site

---

**NOTE**: Neuron is superceded by Emanote; See also: https://github.com/srid/emanote-template

---

[neuron] is a note-taking app optimized for publishing. Use this template repository to get started with [publishing](https://neuron.zettel.page/778816d3.html) your own neuron site that looks like [one of these][examples].

- Login to GitHub and go to 

- Give your new repository a name, say `mynotes`

- Select "*Include all branches*" ([might be necessary to get the site to publish](https://stackoverflow.com/a/47368231/55246))

- Click "Create repository from template"

  - Note: if you are on the free GitHub plan, your repository should be public for GitHub to publish it.

GitHub will now build the site and serve it at: `https://.github.io/mynotes/`.

For more information, see [neuron documentation][neuron] as well as the [GitHub Pages guide](https://help.github.com/en/github/working-with-github-pages).

## Set your site metadata

- In your new repository, edit the `neuron.dhall` file to set your site configuration (such as title, author, color theme) to suitable values.

## How to edit and add notes

Assuming you have changed the `editUrl` configuration in `neuron.dhall` (see the above section), you can simply click the "edit" icon on the published site to edit any note (see [Editing files in your repository](https://help.github.com/en/github/managing-files-in-a-repository/editing-files-in-your-repository) and [Creating new files](https://help.github.com/en/github/managing-files-in-a-repository/creating-new-files)). On every change, your site should eventually rebuild.

To understand how linking works, read [the neuron guide on Linking][linking].

For other ways to edit your notes (editors, web interface), see the [neuron guide][create]. In particular, [Cerveau](https://www.cerveau.app/) is the easiest way to edit your notes on the go.

Got questions? Checkout the [[faq]]. To find who else is using this template *publicly on GitHub*, [see here](https://github.com/search?o=desc&q=filename%3Aneuron.dhall&s=indexed&type=Code).

[neuron]: https://neuron.zettel.page

[examples]: https://neuron.zettel.page/examples

[linking]: https://neuron.zettel.page/linking

[create]: https://neuron.zettel.page/create