How to publish your own neuron site

neuron is a note-taking app optimized for publishing. Use this template repository to get started with publishing your own neuron site that looks like one of these.

• Go to https://github.com/srid/neuron-template/generate
• Give your new repository a name, say mynotes
• Select "Include all branches" (might be necessary to get the site to publish)
• 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://<yourgithubusername>.github.io/mynotes/.

For more information, see neuron documentation as well as the GitHub Pages guide.

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 and Creating new files). On every change, your site should eventually rebuild.

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

For other ways to edit your notes (editors, web interface), see the neuron guide. In particular, Cerveau 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.

Adding Custom Domain

Add cname option in ./github/workflows/publish.yaml under peaceiris/actions-gh-pages@vX.X.X-X as demonstrated in this pr