For full text search please use the '?' prefix. e.g. ? Onboarding

Tutorial

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!

Create a Note

  1. Use Ctrl+L / Cmd+L to bring up the lookup prompt
  2. Type dendron and select Create New

  • NOTE: After you press enter, Dendron will create and open the dendron note. Use <CTRL>-<TAB> to come back to this note

You just created your first note!

  • NOTE: Notes in Dendron are just plain text markdown with some frontmatter on the top. You can edit them in Dendron or using vim your favourite text editor.

Find a Note

  1. Use Ctrl+L / Cmd+L to bring up the lookup prompt again
  2. Type dendron and press <ENTER>

  • TIP: you don't have to type out the entire query, press <TAB> to autocomplete

You just looked up a note!

  • NOTE: in Dendron, you can find or create notes using the lookup prompt

Organize your Notes

  1. Bring up the lookup prompt again
  2. Type tutorial.one

You just created your first hierarchy!

  • NOTE: 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

  • TIP: You can use the Dendron Tree View to view your hierarchy. If it's not currently in focus, you can use CTRL+SHIFT+P/CMD+SHIFT+P to open the command prompt and type in Dendron: focus on tree view to make it appear

  1. In the current note, type [[ - this should trigger the autocomplete. You can type one to narrow it down to the note you just created and hit enter

You just created your first link!

  • NOTE: the links with the [[ are called wikilinks (because they were first popularized by Wikipedia)

  • TIP: If you hover your mouse over the link, you can get a preview of the contents inside the note!

  1. Move your text cursor over the link you just created. Hold down <CTRL>+<ENTER>/<CMD>+<ENTER>

  • TIP: You can also use CTRL+CLICK or CMD+CLICK to navigate links via mouse

You just navigated the link!

Refactor a Note

  1. Open tutorial.one (Private), bring up the command prompt (CTRL+SHIFT+P/CMD+SHIFT+P) and type Dendron: Rename Note
  2. Replace tutorial with my-note and then press <ENTER>
  3. You just refactored the note!

  • NOTE: when you rename a note, Dendron updates all links and references of the original note being renamed. Try switching back to Tutorial to see the updated link!

  • TIP: in addition to renaming one note at a time, dendron has an entire collection of refactoring commands that let you change headers, move around sections, and refactor entire hierarchies!

Conclusion

Congrats, you finished the Dendron tutorial!

Was there anything unclear or buggy about this tutorial? Please report it so we can make it better!

Next Steps

Depending on your needs, here are some common next steps:

Coming from Obsidian? Click here to import your Obsidian notes (or any markdown notes) into Dendron to see how they look.

Community

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:

Backlinks