DOCSEARCHbyAlgolia
Submit Docs

Dendron Documentation

repository·master·Indexed 27 days ago

https://github.com/dendronhq/dendron

A developer-centric, markdown-based personal knowledge management tool that treats notes like code. Features include hierarchical structuring, refactoring, schema enforcement, and native integration with VS Code and VSCodium. The documentation covers user and developer guides, as well as technical details for modules such as @dendronhq/common-all, @dendronhq/common-server, @dendronhq/dendron-cli, and the Dendron Design System.

Tokens
24.2K
Snippets
58
Records
188
Agent score
92%

What's inside Dendron

  1. Overview of Dendron

    master
    Dendron is an open-source, local-first, markdown-based personal knowledge management (PKM) tool designed specifically for developers. It integrates natively with IDEs like VS Code and VSCodium. It is built to handle large-scale knowledge bases (10k+ notes) by applying software engineering principles like structured hierarchies, refactoring, and schema-driven organization to note-taking.

  2. Understand the VS Code extension structure

    master

    A standard extension project contains these key files:

    • package.json: The manifest file where you declare the extension and its commands. This allows VS Code to show commands in the command palette without loading the full plugin.
    • src/extension.ts: The main implementation file. It must export an activate function, which is called when the extension is activated (e.g., by executing a registered command). Inside activate, you use registerCommand to bind logic to a command name.

  5. Supported Markdown elements in Dendron

    master

    Dendron supports a variety of standard and extended Markdown elements for note-taking and documentation. Supported features include:

    • Blockquotes: Use the > character to denote blockquotes.
    • Code Blocks: Use triple backticks (e.g., ```js) to define language-specific code blocks.
    • Math: Supports LaTeX-style math using $ for inline math (e.g., $f(x) = 5$) and $$ for block math.
    • Horizontal Rules: Create separators using --- or ***.
    • Mermaid Diagrams: Embed diagrams using ```mermaid blocks (supports graph TD, classDiagram, etc.).
    • Tables: Standard Markdown pipe tables.
    • Lists: Supports both unordered lists (using *) and ordered/numbered lists (using 1.).
    • Footnotes: Use the [^1] syntax to reference footnotes and [^1]: to define them at the bottom of the document.

  6. Understand the Dendron UI Components

    master

    The Dendron interface consists of several key functional areas:

    • Editor Pane: The primary area for writing and editing Markdown notes.
    • Preview Pane: A read-only view of the rendered Markdown note.
    • Dendron Workspace: A file explorer showing the contents of your Vault (the directory where Dendron stores markdown notes, assets, and helper files). Clicking a note here opens it in the Editor Pane.
    • Outline: A view of the current note's structure based on its Markdown header levels.
    • Tree View: A hierarchical view of your notes, representing the note structure similar to a filesystem folder hierarchy.
    • Backlinks: A list of other notes that contain links pointing to the currently active note.

  8. Understand the Dendron Vault Root

    master
    The root.md file serves as the root of your Dendron vault. If you choose to publish your entire vault, this file acts as your landing page. You can customize the content of this page freely, but you must not modify the YAML frontmatter at the top of the file, as it contains essential metadata (such as id, title, desc, updated, and created) used by the Dendron system.

  9. Explore advanced Dendron features

    master

    Once you are comfortable with the basics, you can extend your usage with the following features:

    • Pods: Import existing notes from other tools.
    • Dendron Publishing: Create a Digital Garden by publishing your notes.
    • Workflows: Discover established patterns for using Dendron effectively.
    • User Guide: Browse the full functional aspects of the tool.

    Comprehensive documentation is available on the Dendron Wiki Site.

  10. Core Features of Dendron

    master

    Dendron provides several key capabilities for managing knowledge:

    • Plaintext Management: Notes are stored as markdown files, allowing for git version control, git blame usage, and editing in any text editor (e.g., Vim).
    • Markdown Extensions: Supports Mermaid for diagrams, KaTeX for math, and note references to embed notes in multiple locations.
    • Lookup & Navigation: Unified interface for finding/creating notes, traversing hierarchies, using backlinks, and visualizing the knowledge base via graph view.
    • Schema & Templates: Ensures consistency through schemas, providing autocomplete hints and automatic template application during note creation.
    • Refactoring: Allows restructuring the knowledge base (renaming notes or sections via regex) without breaking links.
    • Vaults: Uses git-backed folders called 'vaults' to separate different concerns (e.g., personal vs. work) or to collaborate via git.
    • Publishing: Exports knowledge bases as static Next.js sites with fine-grained permissions (per vault, hierarchy, or note).

  12. Overview of Dendron learning paths

    master

    Dendron provides structured learning paths based on your expertise level:

    Trail (Immediate Next Steps)

    Focuses on essential concepts beyond the basic tutorial:

    • Workflows: Learn the Amoeba Workflow for effective note-taking.
    • Navigation: Find note references to headers, identify broken internal links, and use navigation commands.
    • Organization: Use tags, Task Notes, Scratch Notes, Daily Journal Notes, and Hierarchies. Learn to use Templates and Schemas.
    • Sharing: Back up vaults using Git/GitHub and explore the awesome-dendron resource list.

    Forest (Intermediate Topics)

    Focuses on customizing Dendron for specific workflows:

    • Retrieval: Use Lookup Modifiers to customize search functionality.
    • Editing: Understand and extend note metadata using Frontmatter Attributes.
    • Organization: Manage different types of Vaults and Workspaces, including working with multiple Vaults in a single workspace.
    • Sharing: Publish notes to Netlify/GitHub Pages and access notes on mobile devices.
    • Transfer: Use Pods to export/import notes between different formats.

    Wilderness (Advanced Topics)

    Focuses on cutting-edge and collaborative usage:

    • Collaboration: Best practices for using Dendron with teams.
    • Extending: Mastering the API and Hooks.