From afc58e2736881e6f5376dfcd1e67640e8b36d267 Mon Sep 17 00:00:00 2001 From: Michael Nguyen Date: Sat, 25 May 2024 19:53:49 -0700 Subject: [PATCH] Proofread `dendron.md` --- vault/dendron.md | 91 +++++++++++++++++++++++++----------------------- 1 file changed, 48 insertions(+), 43 deletions(-) diff --git a/vault/dendron.md b/vault/dendron.md index 0c3e2cfa7..6e41c028f 100644 --- a/vault/dendron.md +++ b/vault/dendron.md @@ -2,7 +2,7 @@ id: b0fe6ef7-1553-4280-bc45-a71824c2ce36 title: Dendron desc: '' -updated: 1660951930114 +updated: 1716691779018 created: 1595952505017 --- @@ -17,7 +17,7 @@ created: 1595952505017 ![Dendron Logo](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/logo-256.png) Dendron is an **open-source, local-first, markdown-based, note-taking tool**. -Think of it as a **cache for everything that you care about** - if you've spent **more then five minutes** solving a problem, you should **never** spent any more time solving the same exact problem. +Think of it as a **cache for everything that you care about** - if you've spent **more than five minutes** solving a problem, you should **never** spend any more time solving the same exact problem. Dendron is a knowledge base built by and for developers and integrates natively with IDEs like [VS Code](https://code.visualstudio.com/) and [VSCodium](https://vscodium.com/). @@ -29,47 +29,47 @@ Dendron is a knowledge base built by and for developers and integrates natively ## How Dendron builds on top of the past five decades of programming languages and developer tooling. We apply the key lessons from software to the management of general knowledge. -We make managing general knowledge like managing code and your PKM like an IDE. +We make managing general knowledge like managing code and your personal knowledge management (PKM) like an integrated development environment (IDE). ## Design Principles -### Developer Centric +### Developer-Centric -Dendron aims to create a world class developer experience for managing knowledge. +Dendron aims to create a world-class developer experience for managing knowledge. Our goal is to provide a tool with the efficiency of Vim, the extensibility of Emacs, and the approachability of VS Code. What this means: -- dendron features are text centric and composables -- dendron provides the lowest friction interface for working with your knowledge base -- dendron optimizes for efficiency, speed, and keyboard focused ux -- dendron comes with sane defaults and the ability to customize to your liking -- dendron can be extended along any dimension +- Dendron features are text-centric and composables. +- Dendron provides the lowest friction interface for working with your knowledge base. +- Dendron optimizes for efficiency, speed, and keyboard-focused UX. +- Dendron comes with sane defaults and the ability to customize to your liking. +- Dendron can be extended along any dimension. ### Gradual Structure Dendron extends markdown with structural primitives to make it easier to manage at scale and tooling on top to work with this structure. -Different knowledge bases require different levels of structure - a PKM used for keeping daily journals is different than a company wide knowledge base used by thousands of developers. +Different knowledge bases require different levels of structure—a PKM used for keeping daily journals is different than a company wide knowledge base used by thousands of developers. Dendron works with any level of structure, meaning you can take free form notes when starting out and gradually layer on more structure as your knowledge base grows more. ### Flexible and Consistent -Dendron is both flexible and consistent. It provides a consistent structure for all your notes and gives you the flexibility to change that structure. +Dendron is both flexible and consistent. It provides a consistent structure for all your notes while giving you the flexibility to change that structure. -In Dendron, you can refactor notes and Dendron will make sure that your PKM is consistent throughout. This means that you have the best of both worlds: a basic structure for the organization but the flexibility to change it. +In Dendron, you can refactor notes, and Dendron will ensure that your PKM remains consistent throughout. This means you have the best of both worlds: a basic structure for organization with the flexibility to change it. ## Features Dendron has hundreds of features. The following is a list of highlights. -### It's just Plaintext +### It's Just Plaintext -- manage using git -- use git blame to see individual edits -- edit in anything that works on text files (eg. Vim) +- Manage using Git. +- Use Git blame to see individual edits. +- Edit in anything that works on text files (e.g., Vim). @@ -77,9 +77,9 @@ Dendron has hundreds of features. The following is a list of highlights. ### Markdown and More -- create diagrams using mermaid -- write math using katex -- embed notes (and parts of notes) in multiple places using note references +- Create diagrams using Mermaid. +- Write math using KaTeX. +- Embed notes (and parts of notes) in multiple places using note references. @@ -87,8 +87,8 @@ Dendron has hundreds of features. The following is a list of highlights. ### Lookup -- one unified way to find and create notes -- quickly traverse and create new hierarchies +- One unified way to find and create notes. +- Quickly traverse and create new hierarchies. @@ -96,9 +96,9 @@ Dendron has hundreds of features. The following is a list of highlights. ### Schema -- ensure consistency for your knowledge base -- get autocomplete hints when creating new notes -- automatically apply common templates to notes on creation +- Ensure consistency for your knowledge base. +- Get autocomplete hints when creating new notes. +- Automatically apply common templates to notes on creation. @@ -106,9 +106,9 @@ Dendron has hundreds of features. The following is a list of highlights. ### Navigation -- explore relationships using backlinks -- navigate to notes, headers and arbitrary blocks -- visualize your knowledge base using the graph view +- Explore relationships using backlinks. +- Navigate to notes, headers, and arbitrary blocks. +- Visualize your knowledge base using the graph view. @@ -116,9 +116,9 @@ Dendron has hundreds of features. The following is a list of highlights. ### Refactor -- restructure your knowledge base without breaking links -- rename a single note or refactor using arbitrary regex -- rename and move individual sections within notes +- Restructure your knowledge base without breaking links. +- Rename a single note or refactor using arbitrary RegEx. +- Rename and move individual sections within notes. @@ -126,9 +126,9 @@ Dendron has hundreds of features. The following is a list of highlights. ### Vaults -- mix and match knowledge using vaults, a git backed folder for your notes -- use vaults to separate concerns, like personal notes and work notes -- publish vaults on git to collaborate and share knowledge with others +- Mix and match knowledge using vaults, which are Git-backed folders for your notes. +- Use vaults to categorize concerns, such as personal notes and work notes. +- Publish vaults on GitHub to collaborate and share knowledge with others. @@ -136,9 +136,11 @@ Dendron has hundreds of features. The following is a list of highlights. ### Publish -- export your knowledge base as a static (nextjs) site -- lookup locally and share globally with generated links -- manage what you publish using fine grained permissions on a per vault, per hiearchy and per note basis +### Publish + +- Export your knowledge base as a static (Next.js) site. +- Look up locally and share globally with generated links. +- Manage what you publish using fine-grained permissions on a per-vault, per-hierarchy, and per-note basis. @@ -146,12 +148,15 @@ Dendron has hundreds of features. The following is a list of highlights. ## Use Cases -- personal knowledge management (PKM) -- documentation -- meeting notes -- tasks and todos -- blogging -- customer relationship management +### Use Cases + +- Personal knowledge management (PKM) +- Documentation +- Meeting notes +- Tasks and to-dos +- Blogging +- Customer relationship management (CRM) + ## Getting Started