Web interface

Neuron can generate a fully-functional and self-sufficient web site out of your zettelkasten. It generates the HTML files under your Zettelkasten directory, in .neuron/output/, as well as spin up a server that will serve that generated site at localhost:8080.

neuron gen -wS

The gen command takes a few options, notably:

You can override the output directory path using -o.
You can override server settings such as the host and port. For example,
```
neuron gen -ws 127.0.0.1:8081
```
You can choose pretty URLs (i.e., /foo instead of /foo.html) using --pretty-urls.

Additional CLI details are available via --help.

Local site without server

The web interface can also be accessed without necessarily running the server. First run neuron generator in “watch mode” only (no http server):

# Watch only, without serving
neuron gen -w

Leave this command running in one terminal, and then use neuron open to directly open the locally generated HTML site.

Publishing to the web

See Automatic Publishing#

Features

(See the links below)

Impulse
- Impulse displays a full index to your generated statically-generated Web interface. It displays the zettelkasten Folgezettel Heterarchy for all Clusters# in the zettelkasten graph.
Zettel ID
- A title ID is one that uses arbitrary text, typically denoting the title of the note. For example, in the link [[Some note title]] (see Linking), “Some note title” is the title ID, corresponding to the note filename Some note title.md, that is generated in the Web interface as the HTML file named some-note-title.html (unless you override this slug in Zettel metadata).
Tutorial
- Now run the neuron Web interface on the ./doc Zettelkasten:
- Your Zettelkasten directory should now contain two zettels–named 6479cd5e.md and index.md. Now it is time to run the neuron Web interface:
Linking
- In Web interface, neuron will automatically display the title of the linked zettel.
Directory Tree
- Given a file ./Home/Projects/HouseWarming.md this plugin will create three zettels with Zettel IDs Home, Projects, and HouseWarming. In the Web interface, neuron will display the “contents” of a directory beneath the zettel content.
- No addtional zettels are generated, but any content in the HomeProjects.md file will be shown in the generated HomeProjects.html file in the Web interface.
- Once Neuron generates the Zettelkasten, the directory structure is discarded from memory and not used in the Web interface. All of the generated notes are made accessible at the ‘top’ level of the generated site–you don’t need to navigate down the on-disk directory structure in the Web interface.
- Once Neuron generates the Zettelkasten, the directory structure is discarded from memory and not used in the Web interface. All of the generated notes are made accessible at the ‘top’ level of the generated site–you don’t need to navigate down the on-disk directory structure in the Web interface.

Guide#
- Basics: A neuron notebook is just a directory of Zettel Markdown files, which are identified by Zettel ID. Neuron transforms it into a Web interface, that is generated statically (self-contained HTML files). Advanced functionality are added via Plugins.
- Parent directory zettel