The Lookup Bar is the main way to interact with Dendron. You can use it for both finding notes and creating new notes. To find a note, run
Dendron: Lookup (
Cmd+L) to bring up the Lookup Bar.
Creating a Note
🌱 ACTION: Let's use the lookup to create a note! Open the lookup bar with
Enter. Afterward, you can use the
Cmd+Tabshortcut to get back to the previous note you were viewing.
This creates a note named
recipes.md. Notes in Dendron are just plaintext Markdown. Notes:
- Live locally on your file system.
- Are portable across operating systems and a variety of software.
- Make importing/exporting easier, including publishing your notes to a hosted website.
You can try to add some content to the body of your
recipes note now.
--- section at the top of each note is frontmatter. Frontmatter contains custom attributes at the top of each Markdown file, autogenerating some at creation time. Dendron uses it to store metadata about each note for features like publishing.
💡 TIP: Frontmatter attributes have some rules to keep in mind. Here are a few:
- Don't modify the
createdattributes in frontmatter.
updatedattribute automatically updates whenever you make a new modificaiton to a file.
- See reserved keys in frontmatter for more information.
Creating a hierarchy
Dendron organizes your notes into hierarchies. These are
. ("dot" or "period") delimited Markdown files.
Below is a hypothetical hierarchy for a file tree:
. └── project1/ ├── designs/ │ └── promotion.png ├── paperwork/ │ └── legal.md └── tasks/ ├── task1.md └── task2.md
The same hierarchy in Dendron would look like the following:
. ├── project1.md ├── project1.designs.md ├── project1.designs.promotion.md ├── project1.paperwork.md ├── project1.paperwork.legal.md ├── project1.tasks.md ├── project1.tasks.task1.md └── project1.tasks.task2.md
🌱 ACTION: To create a hierarchy, bring up lookup again (
recipes.vegetarianand then press enter.
Take a look at the tree view to see the
vegetarian note under the
recipes hierarchy. You can also see the note stored as
recipes.vegetarian.md in the File Explorer Pane.
In this case, vegetarian is considered a child note of recipes. When looking at the
recipes note, the preview view will list
vegetarian (and any other
recipes.* notes) at the bottom as Children. Children can also be seen and navigated via the tree view.
Hierarchy at any level
You can create a hierarchy at any level.
🌱 ACTION: Type the following into lookup and hit enter:
You'll see there is a
+ sign next to
desserts when viewing in the lookup or tree view. The plus sign indicates that this note is a stub. A stub is a placeholder for a note that hasn't been created. Dendron uses stubs to avoid cluttering your file system with empty notes when creating hierarchies.
Following this recipes example, you can create other related notes. Some examples:
recipes.favorites recipes.italian.appetizers recipes.chinese recipes.chinese.appetizers.wontons recipes.ingredients.favorites recipes.ingredients.shopping-list
You may be wondering why Dendron uses hierarchies. You can read here for our thoughts about structure. Dendron also allows you to easily change the hierarchies later if you change your mind on how to organize your notes. This is covered later in Refactoring in Dendron.
To find notes, we use the same lookup interface that we used to create them.
🌱 ACTION: Open Lookup, and type
vege. This will find your
Enterto open that note.
Lookup uses fuzzy search, which means you can type out partial queries and still see the results. Entering multiple keywords delimited by space will lookup matching notes regardless of order of the keywords.
rec vegewill match the
💡 TIP: More approaches to using lookup can be found in Finding Notes.
- Tutorial Step 3: Linking Notes