Tutorial

Make sure you have already installed neuron (see 2011501Installing). 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 2011405Web interface on the ./guide Zettelkasten:

neuron ./guide rib serve

It can be accessed at localhost:8080. It should match what you see at neuron.srid.ca.

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 2011404Zettel Markdown notes. Create an empty directory:

cd ~
mkdir ./notes

Now create (see 2011406Creating and Editing zettels) your first zettel file:

neuron ./notes new "My first zettel" | xargs -rt vim

This will open the vim text editor (you may of course use the text editor of your choice) 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 2011504Linking) to your first zettel (we will assume its filename is “2011501.md”) in it:

$ cat > ./notes/index.md
---
title: Overview
---
* [2011501](z:/)
^D
$

Your Zettelkasten directory should now contain two zettels—named 2011501.md and index.md. Now it is time to run the neuron 2011405Web interface:

neuron ./notes rib serve 

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 2011503Graph view 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.

Connections
    Navigate up