From a6d511ad6da3e2785c0c17660a4ba4e553885945 Mon Sep 17 00:00:00 2001 From: Matthew Dillon Date: Sat, 17 Oct 2020 19:40:01 -0700 Subject: [PATCH] strip readme --- README.md | 33 +-------------------------------- 1 file changed, 1 insertion(+), 32 deletions(-) diff --git a/README.md b/README.md index 68823f9..910bd24 100644 --- a/README.md +++ b/README.md @@ -1,32 +1 @@ -# How to publish your own [neuron] site - -[neuron] is a note-taking app optimized for publishing, and you can 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]. - -- Go to -- Give your new repository a name, say `mynotes` -- Select "*Include all branches*" ([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. - -Questions? Checkout the [[faq]]. - -[neuron]: https://neuron.zettel.page/ -[examples]: https://neuron.zettel.page/examples.html -[linking]: https://neuron.zettel.page/linking.html -[create]: https://neuron.zettel.page/create.html \ No newline at end of file +# zettel.thermokar.st