id | title | desc | updated | created | currentStep | totalSteps |
---|---|---|---|---|---|---|
wv8pjhxjjrp5bnwlz2kznsg |
Readme |
1660931467392 |
1659721741451 |
0 |
0 |
Welcome to Dendron! Dendron is a developer-focused knowledge base that helps you manage information using flexible hierarchies!
You are currently in the tutorial vault (a vault is the folder where your notes are stored). Feel free to edit this note and create new files as you go through the quickstart!
- Use
Ctrl+L
/Cmd+L
to bring up the lookup prompt - Type
dendron
and selectCreate New
Congrats, you just created your first note! Notes in Dendron are plain text markdown with frontmatter on top. You can edit them in Dendron or using vim your favourite text editor.
NOTE: You might have noticed that the tutorial preview has not changed - this is because it is currently
locked
. This keeps the preview from changing as you edit notes. We will teach you at the end how to unlock the preview.
- Use
Ctrl+L
/Cmd+L
to bring up the lookup prompt again - Type
tutorial
and press<ENTER>
TIP: you don't have to type out the entire query, press
<TAB>
to autocomplete
You just found a note. We refer to both finding and creating of notes using the lookup prompt as performing a lookup.
- Dendron has a custom Tree View to view your notes. If it's not currently in focus, you can use
CTRL+SHIFT+P
/CMD+SHIFT+P
to open the command prompt and type inDendron: focus on tree view
to make it appear - Lookup
tutorial.one
. Notice that the Dendron Tree View will correctly nest theone
note under thetutorial
note.
You just created your first hierarchy!
Hierarchies in Dendron are just .
delimited files. This makes each note both a file and a folder and makes it easy to keep your notes organized
- In
tutorial.one
, type[[
- this should trigger the autocomplete. You can typeden
to narrow it down todendron
and hit enter
You just created a link! If you hover your mouse over the link, you can get a preview of the contents inside the note!
NOTE: the links with the
[[
are called wikilinks (because they were first popularized by Wikipedia)
- Move your text cursor over the link you just created. Hold down
<CTRL>+<ENTER>
/<CMD>+<ENTER>
You just navigated the link! You can also use CTRL+CLICK
or CMD+CLICK
to navigate links via mouse.
- Inside [[dendron]], bring up the command prompt (
CTRL+SHIFT+P
/CMD+SHIFT+P
) and typeDendron: Rename Note
- Replace [[dendron]] with
my-note
and then press<ENTER>
- Go back to [[tutorial.one]] - you should see the updated link!
You just renamed a note! When you rename a note, Dendron updates all links and references of the original note.
Renaming is just one of the many ways you can refactor your knowledge base - some other common use cases include renaming headings, merging notes, and renaming entire hierarchies using regex.
To unlock, click the lock icon on the top right of the page or use the Dendron: Toggle Preview Lock command. Now click on the editor again on a new page. You should see the preview change.
Congrats, you finished the Dendron tutorial!
Was there anything unclear or buggy about this tutorial? Please report it so we can make it better!
Depending on your needs, here are some common next steps:
-
I want to start writing: Create a daily journal note (docs)
-
I want to use templates: Use the Appy Template command to apply templates to existing notes
-
I want to do a longer tutorial: Check out our 5min tutorial to explore more of Dendron's functionality
-
I want to implement a particular workflow (bullet journal, zettelkasten, etc): Check out community workflow guides
-
I want to use Dendron for tasks and todos: See the Getting Things Done (GTD), Bullet Journaling, and Other Task Management Workflows for how the founder of Dendron uses it to manage his work.
-
I want to explore advanced features: See next steps for longer walkthroughs and advanced functionality!
-
I want to start clean with a new vault at a custom location: Run Dendron: Initialize Workspace from the command prompt (or click this link) to start from a clean slate
-
I want to use Dendron as a knowledge base for my team: Read the Dendron team setup to get started
Coming from Obsidian? Click here to import your Obsidian notes (or any markdown notes) into Dendron to see how they look.
Dendron is more that just a tool - we are also a community of individuals that are passionate about knowledge management. If you need help or want to connect with the community, join us in the Discords.
You can also:
- Star us on GitHub
- Follow us on Twitter
- Subscribe to the Dendron Newsletter