You might be wondering why we are using Markdown for documentation.
Markdown can be used for everything. People use it to create websites, documents, notes, books, presentations, email messages, and technical documentation.
Markdown is portable. Files containing Markdown-formatted text can be opened using virtually any application. If you decide you don’t like the Markdown application you’re currently using, you can import your Markdown files into another Markdown application. That’s in stark contrast to word processing applications like Microsoft Word that lock your content into a proprietary file format.
Markdown is platform independent. You can create Markdown-formatted text on any device running any operating system.
Markdown is future proof. Even if the application you’re using stops working at some point in the future, you’ll still be able to read your Markdown-formatted text using a text editing application. This is an important consideration when it comes to books, university theses, and other milestone documents that need to be preserved indefinitely.
Markdown is everywhere. Websites like Reddit and GitHub support Markdown, and lots of desktop and web-based applications support it.
Readbefore you continue.
This wiki is written using the Zettelkasten style of note taking.
Our internal documentation is scattered in documents stored in ClickUp, Google Drive, Slack messages, and emails. It would be nice if we had a system to associate notes with one another.
Using a local server
neuron gen -wS
Production deployments are automated using Github actions. Please read the zettelfor more information about deployments.
Adding images and other files
Place images and other files in the static folder. See documentation.
Neuron will automatically copy them as is to the output folder.
Other pages on this zettelkasten: