Make sure you have already installed neuron (see). Then follow this tutorial to get your own Zettelkasten up and running.
Test with an existing Zettelkasten
The neuron git repo comes with a Zettelkasten of its own at the
./guide folder. Indeed, the very site you are viewing is generated by neuron from that Zettelkasten. Our goal in this section is to use neuron to generate this site locally, such as to give you a feel for how neuron works before using it to create your own Zettelkasten.
You will need to clone the git repository:
git clone https://github.com/srid/neuron.git cd neuron
Now run the neuron
neuron -d ./guide rib -wS
Create your own Zettelkasten
There are two ways to do this. You may copy the
./guide directory and work from there; or create one from scratch. For this tutorial, we choose the latter.
Neuron expects a Zettelkasten directory to be nothing more than a list of
~/zettelkasten will be used as your neuron directory (which you can override using the
-d option). Create this directory first:
Now create (see) your first zettel file:
neuron new "My first zettel" -e
This will open your text editor1 with the newly created file and its title already filled in. Enter some text, and exit the editor.
Next, create an “overview” zettel called
index.md — it would be the welcoming page of our Zettelkasten web interface — and link it (see ) to your first zettel (we will assume its filename is “2011501.md”) in it:
$ cat > ~/zettelkasten/index.md --- title: Overview --- * <2011501> ^D $
Your Zettelkasten directory
~/zettelkasten should now contain two zettels–named
index.md. Now it is time to run the neuron :
neuron rib -wS
-woption will watch your Zettelkasten directory and regenerate HTML files.
-Soption runs a HTTP server serving the generated HTML files. (You can ignore it, and use
Access it at localhost:8080. You should expect to see the contents of your overview zettel, which should link to the first zettel created. Clicking the tree icon in the footer should take you to the of your Zettelkasten.
Growing your Zettelkasten
Congratulations, you have created your first Zettelkasten using neuron! From this point, simply use the
new command to create new zettels and establish links. As your Zettelkasten grows over time, more value will be derived from it.
Readnext to learn all the concepts and features in Neuron.
$EDITORenvironment variable must be set pointing to the text editor for this to work.