Giter VIP home page Giter VIP logo

dendron-site's Introduction

dendronhq on Twitter Dendron on YouTube Discord VS Code Installs of Dendron

Dendron site build URL validator

Dendron

Dendron Logo

Dendron is an open-source, local-first, markdown-based, note-taking tool. It's a personal knowledge management solution (PKM) built specifically for developers and integrates natively with IDEs like VS Code and VSCodium.

Why

Most PKM tools help you create notes but slam into a wall retrieving them once your knowledge base reaches a certain size threshold. That threshold varies with the tool, but virtually everything stops working past 10k notes unless the user was extremely diligent about organizing their knowledge. Past this threshold, entropy wins and every query becomes a keyword search and scrolling through pages of results.

Dendron's mission is to help humans organize, find, and work with any amount of knowledge.

It not only helps you create notes but also retrieve them - retrieval works as well with ten notes as it does with ten thousand.

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.

Design Principles

Developer Centric

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

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.

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.

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.

Features

Dendron has hundreds of features. The following is a list of highlights.

It's just Plaintext

  • manage using git
  • use git blame to see individual edits
  • edit in anything that works on text files (eg. Vim)

Markdown and More

  • create diagrams using mermaid
  • write math using katex
  • embed notes (and parts of notes) in multiple places using note references

Lookup

  • one unified way to find and create notes
  • quickly traverse and create new hierarchies

Schema

  • ensure consistency for your knowledge base
  • get autocomplete hints when creating new notes
  • automatically apply common templates to notes on creation

Navigation

  • explore relationships using backlinks
  • navigate to notes, headers and arbitrary blocks
  • visualize your knowledge base using the graph view

Refactor

  • restructure your knowledge base without breaking links
  • rename a single note or refactor using arbitrary regex
  • rename and move individual sections within notes

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

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

Use Cases

  • personal knowledge management (PKM)
  • documentation
  • meeting notes
  • tasks and todos
  • blogging
  • customer relationship management

Getting Started

Interested in trying out Dendron? Jump right in with the Getting Started guide!

Join Us

Dendron wouldn't be what it is today without our wonderful set of members and supporters.

Community Calendar

We have a bunch of community events that we host throughout the week. You can stay up to date on whats happening by taking a look at our community calendar!

Dendron Newsletter

Dendron sends out a weekly newsletter highlighting:

Join other Dendrologists

There are a variety of ways to connect with Dendron devs, contributors, and other members of the Dendron community:

Contributors ✨

Dendron wouldn't be what it is today without help from the wonderful gardeners 👨‍🌾👩‍🌾

If you would like to contribute (docs, code, finance, or advocacy), you can find instructions to do so here

License

Dendron is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3.

See LICENSE and NOTICE for more information.

The above license information is in regard to the Dendron software project in the dendronhq/dendron repository. When it comes to this repository, the dendronhq/dendron-site repository of documentation, this is released under the MIT License

dendron-site's People

Contributors

aleksey-rowan avatar benhsm avatar bpathakota avatar ccamara avatar cconrad avatar ding-fan avatar ens100 avatar gamtiq avatar gereleth avatar ghanvik avatar harshita-mindfire avatar hayata-suenaga avatar hfellerhoff avatar hikchoi avatar johndendron avatar jonathanyeung avatar jpknwls avatar kap42 avatar kevinslin avatar kpathakota avatar lukecarrier avatar mandarvaze avatar nickolay-kondratyev avatar rlh1994 avatar scriptautomate avatar seriousbug avatar simkimsia avatar sr-- avatar tma66 avatar tsnieman avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

dendron-site's Issues

Reference to Dendron Markdown Preview Enhanced : Outdated ?

Which docs page should be improved?

https://wiki.dendron.so/notes/ba97866b-889f-4ac6-86e7-bb2d97f6e376/

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

Isn't the Dendron Markdown Preview Enhanced outdated ?

Might well be that I misunderstood. I have no idea for a better sentence, unfortunately

Suggested fix, improvements or additions

No response

More powerful template enginge

Maybe it is already implemented but not documented:

I would like to builid more complex templates using list variables in the front matter and loop through them with golang template or jinja like syntax. It would be nice to have more power there.
What dialect of templating are you using at the moment (would be nice to document)?

Thanks for this nice project!

Use tooling to enforce, and prevent conflicts with, a documentation Style Guide

Follow-up to #333

Use tooling to enforce, and prevent conflicts with, a style guide.

We should look at something like Vale, and pair with pre-commit. This would help with a variety of things, but could start with one:

  • Inconsistent capitalization, or otherwise different forms of case

This may be something more like three separate issues:

Potential Issues

  • Base Dendron dictionary
    • Including terms in this issue
  • pre-commit application of Vale, and other project standards
    • Would need to include contributor documentation for installing/using pre-commit
  • Spellcheck, using something like Vale or codespell or other solution
  • Style guide checking use Vale (ex. Google Style Guide)
  • Process for updating/syncing with latest style guide, using something like Vendir
  • Implement something like behave (or TypeScript equiv) to actually test the style guide via BDD, ensuring that it is working as intended

Term Dictionary Example

Examples to include:

next.js|NextJS|Next.js
markdown|Markdown
markdown based|Markdown-based
github|GitHub
github actions|GitHub Actions
linkedin|LinkedIn
vscode|VS Code
twitter|Twitter
dendron|Dendron
obsidian|Obsidian
json|JSON
jekyll|Jekyll
dendron cli|Dendron CLI
vim|Vim
pdf|PDF
css|CSS
obsidian|Obsidian
youtube|YouTube
svg|SVG
js|JS
scss|SCSS
dendron//|dendron://
cli|CLI
edge browser|Edge browser
react|React
emacs|Emacs
sublime text|Sublime Text
microsoft word|Microsoft Word
now a days|nowadays
vs code insider|VS Code Insider
elasticsearch|Elasticsearch
vscodium|VSCodium
evernote|Evernote
github flavored markdown|GitHub Flavored Markdown
facebook|Facebook
github pages|GitHub Pages
wikipedia|Wikipedia
dendron next|Dendron Next
seed membership|Seed membership
dendron markdown preview|Dendron Markdown Preview
discord|Discord
rfc|RFC
gitlab|GitLab
foam|Foam
roam|Roam
chrome|Chrome
firefox|Firefox
google|Google
gmail|Gmail
airtable|Airtable

Using Vendir

Now that I think of the Vendir stuff, examples of it being used in another open source project salt-user-guide:

Other thoughts

I can see this style guide being something that exists in a standalone repo under the dendronhq org, so that the style guide:

  • Is portable/reusable. Making it easier so that it can be used by anyone in their own vaults/workspaces/projects

Mentioning VSCode Experimental File Nesting in Docs?

Which docs page should be improved?

https://wiki.dendron.so/notes/f3a41725-c5e5-4851-a6ed-5f541054d409/

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

VSCode version 1.64 (January 2022) added an experimental "Explorer file nesting" feature. When enabled this can be used to group files under other files, giving a nested directory-like structure even to a flat directory.

It might be worth adding this to the documentation, I'm happy to do a PR for it but I don't know if (1) this fits with the approach of Dendron or if (2) adding experimental vscode features to the docs is a good idea.

Suggested fix, improvements or additions

This can be used to tidy up and collapse sections of the file view, for example this is what my daily notes look like with this enabled:

image

This is achieved by:

  "explorer.experimental.fileNesting.patterns": {
    "daily.journal.2022.*.md": "daily.journal.2022.$(capture).*.md"
  },
  "explorer.experimental.fileNesting.enabled": true,

$(capture) refers to the content of the wildcard of the key. So this means that a file matching daily.journal.2022.*.md will appear to be the parent of daily.journal.2022.$(capture).*.md, e.g. for daily.journal.2022.01.md, 01 is capture, so daily.journal.2022.01.md will be the parent of any files matching daily.journal.2022.01.*md.

This should also work with deeply nested structures, so another rule can be made to group files together by the year.

Could also be done to group schemas together, something like "schemas.yml": "*.schema.yml" would group together all schemas under a schemas.yml file.

Replace usage of brok with blc or equivelant npm package

GitHub doesn't like all the calls that brok is doing against it, and brok doesn't have much support for customizing output around particular status returns. I'm going to add it to .brokignore for now so that this PR passes without the 429 failures, as I'd like to suppress 429 failures since they aren't the same as 404, etc.

I'm going to make a follow-up issue that could enhance the URL validator approach, in the future, with some starter commands that I'd have to experiment with at a later date. This approach would allow for internal links as well as external links, and would ensure that the site can build without errors. It seemed like using blc, or other npm based tool would be more forward thinking in case anything like dendron-cli would be extended to make use of the package (or similar package).

# container
# node:14-bullseye-slim
npm install broken-link-checker
npm install serve
npm install @dendronhq/dendron-cli@latest
npm install @dendronhq/dendron-11ty@latest
npx dendron-cli buildSiteV2 --wsRoot .  --stage prod
npx serve 2>> /dev/null &
blc http://localhost:5000/notes -ro --exclude-internal > output-internal.log
blc http://localhost:5000/notes -ro --exclude-external > output-external.log

Originally posted by @ScriptAutomate in #179 (comment)

Firefox users can't click links

Which docs page should be improved?

https://wiki.dendron.so/notes/F5ly88oU0ecUiACLxET5E/

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

Hi:
It looks like this is everywhere at the Documentation wiki. I've referenced the URL above because it's easy to see the problem there.
In the content pane, no matter where I hover, the same URL will be fetched.
It's as if the entire content is wrapped in an tag.

Using Firefox's inspector, it looks like this pattern might be the problem?

Using Firefox's Inspector and removing all of those tags, it looks hovering over a link now shows the proper URL.

In any case, links are not working there at all.

I apologize for the vagueness of this report. The problem is everywhere at the documentation that I've looked, and it should be pretty obvious for anybody trying to use it (using Firefox).

The screenshot shows the FF Inspector. Note that that no matter where the pointer moves in the highlighted area, the URL stays the same.

image

Again, sorry for the vagueness here. Please let me know if I can clear anything up.

This doesn't appear to be happening with Chrome.

Suggested fix, improvements or additions

Maybe clobber the svg tag referenced?

Site Reorg Follow-up tasks

These tasks are remaining after work done for the initial site reorg, as discussed in dendronhq/dendron#1665

More info

For organizing, if you look at FAQ or CLI, they are either random or alphabetically ordered. We want to order them the same way we do our user guide

  • Basics: fundamental core features of Dendron
  • Editing
  • Retrieving
  • Organizing
  • Sharing
  • Transferring: move notes to other places (pods)
  • Extending: extending Dendron (note type system, custom pods, hooks)

include a helpful edit in github link that shows up in the tutorial as well

Problem

Newbie to dendron. Went thru tutorial. noticed that it's outdated. posted a question in discord and volunteer to PR it.

reply was to send a PR directly via Edit in GitHub link.

Cannot find.

Context in Discord

https://discord.com/channels/717965437182410783/735365126227493004/902374533657411636
https://discord.com/channels/717965437182410783/735365126227493004/902381062875914261
https://discord.com/channels/717965437182410783/735365126227493004/902381259794292747

image

Requested by ScriptAutomate

@ScriptAutomate asked me to write up this issue here

https://discord.com/channels/717965437182410783/735365126227493004/902386206413840435

Please define "stubs" on Dendron Doctor page

Which docs page should be improved?

https://wiki.dendron.so/notes/ZeC74FYVECsf9bpyngVMU/#removestubs

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

Stubs are defined as "Stubs are notes that don't exist but that you might want to create."
But the Dendron: Doctor command says it removes stubs... that makes no sense to me.
I see a couple possibilities:
A stub doc is any document with frontmatter but no other content - which scares me and I would like to disable this option
or
A stub doc is any document with frontmatter, no other content, and no backlinks this is what I am looking for
or
A stub doc is any document with no content
or
other?

Suggested fix, improvements or additions

No response

Error when I try to Initialize Workspace

When I enter "Dendron: Initialize Workspace" in the command bar, I get the following error:

Command 'Dendron: Change Workspace' resulted in an error (command 'dendron.changeWS' not found)

Other commands appear to do the same thing.

Configuration for logo / logoPath

Which docs page should be improved?

https://wiki.dendron.so/notes/f2ed8639-a604-4a9d-b76c-41e205fb8713/#logo

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

I think the logo section may be out of date. I tried using logo and that didn't work, but using logoPath under publishing did work for config v5.

Suggested fix, improvements or additions

I got this working example from the dendron.yml for the docs. The key is now logoPath and located under publishing.

logoPath: vault/assets/images/logo.png

Also, I think it would be helpful to explicitly state where in the config hierarchy certain keys are expected by providing a minimal example.

publishing:
    logoPath: vault/assets/images/logo.png

Outdated config guide about mermaid remains in Markdown page.

Which docs page should be improved?

https://wiki.dendron.so/notes/f83c1d87-eac0-48f3-a5cf-8a69989d8ec1/#mermaid-optional

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

NOTE: in order to publish diagrams, you'll need to enable mermaid in the config

in Dendron/Topics/Markdown

Section and value about mermaid in the config are removed.

1519b3c

Suggested fix, improvements or additions

Delete? I'm not sure.

Implementing direct variable replacement

Context: We recently launched a feature (dendronhq/dendron#2045) that had to be commented out because it broke frontmatter variable substitution. Since {{ fm.title }} is not a valid variable from lodash's point of view, it would need to a ReferenceError

Goal: Introduce direct variable replacement

Design decisions:
- What syntax should we adopt for this? eg. <%= =>
- Currently we use {{ }} for frontmatter substitution. This doesn't replace the contents of the note, but rather changes how it's displayed in the preview
- Should we use a different syntax for direct substitution (ie to replace note content)?
- Implementation wise, lodash supports js execution. should we support this as well?
- Additional feature that requires extra check (workspace trust)

Some of the per-note frontmatter for publishing is still only listed in legacy publishing

Which docs page should be improved?

https://wiki.dendron.so/notes/ffec2853-c0e0-4165-a368-339db12c8e4b/

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

There's quite a few flags/values that could be useful for publishing that are specified per-note, e.g. the nav_exclude flag which is used within dendron site itself (https://github.com/dendronhq/dendron-site/blob/master/vault/dendron.topic.md ) but these are only documented (at least where I can find) in the legacy publish pages instead of in the new ones.

It would be good to have all relevant front-matter listed within the current publishing notes.

Suggested fix, improvements or additions

I'm not sure if it should be based in here or somewhere else? https://wiki.dendron.so/notes/fabYbPyk3DMCMoG92lIrq/

Creating child note from parent

I'm really enjoying Dendron so far, but as I start getting deeper into hierarchies, it gets cumbersome to write out the entire path as a backlink and then use the Go To shortcut to create it. Is there a command to pre-populate the descendent branch or a better way of doing this workflow so I can just add the child note name and then create it?

General Typos and Grammar Corrections

Have you spotted a typo or general grammar problem? 📝 ✔️ You can reference this issue in your pull request to help us improve the quality of our site, without having to create a paired issue for the small fixes.

Greenhouse Event link to A Day in Dendron is broken

I guess this is the same issue I reported on dendron-docs.

Example

This is the markdown:

Check out an end-to-end workstyle, managing 20k notes, using schemas and daily journals from [[A Day in Dendron|dendron://dendron.dendron-site/community.greenhouse.2021-07-23-using-dendron-with-20k-notes]]

This is what gets rendered:

Check out an end-to-end workstyle, managing 20k notes, using schemas and daily journals from A Day in Dendron (Private)

Multiple instances of examples for schema confuse me

https://github.com/kevinslin/schemas
https://github.com/dendronhq/schema-library/tree/main/vault

See the search results for schema-library : https://github.com/dendronhq/dendron-site/search?q=schema-library

See the search results for kevinslin/schemas: https://github.com/dendronhq/dendron-site/search?q=kevinslin%2Fschemas

Are they meant to be the same or different? and under what circumstances? for a newbie who want to use schemas in their own workspace, what is an ideal example?

Prefer Extension over Plugin

Which docs page should be improved?

https://www.dendron.so

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

The Install button at the bottom of the page calls it a VS Code plugin and links to the marketplace.

Suggested fix, improvements or additions

I think it would make more sense to use the VS Code native terminology of Extension.

Fix documentation around new note references

This is an extension of the conversation in the dendronhq/dendron repo:

Docs Problem

I've been trying to figure out the new way of using reference notes, which was mentioned in a recent PR of mine (#60), as I was still using the old way. Detailed here is the newer way:

I didn't realize there was some cool new ways of working with note references via ![[foo]] instead of ((ref: [[foo]])), but I am struggling with the actual implementation.

This format gets rendered as plain text, and isn't picked up by Dendron at build at all:

![[ dendron.community.showcase
    #Open AWS Catalogue,1
    :#*
]]

Trying to condense together at least gets rendered, but doesn't work as expected:

![[dendron.community.showcase#Open AWS Catalogue,1:#*]]

I get the on-page rendered error of: Start anchor Open AWS Catalogue not found (but it does exist!)

The old format still works:

((ref:[[dendron.community.showcase]]#Open AWS Catalogue,1:#*]]))

After playing around, I realized the new format works only when there is no whitespace in a header reference, and the whitespace is replaced with a -. This means that this rendered properly for the Open AWS Catalogue header:

![[dendron.community.showcase#Open-AWS-Catalogue,1:#*]]

Docs Fix

@kevinslin said the following in dendronhq/dendron#530 (comment):

we need to update the docs. the new style note refs use github style slugging
this is because old note refs weren't able to handle special characters in the headers
tldr: whitespace is no longer supported because github-slugger doesn't support it. if you use the cmd+shift+r shortcut on a header, we will automatically sluggify the note ref

Browse note stops mid-sentense

Which docs page should be improved?

https://wiki.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47/#browse-note

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

The description of the command Browse Note cuts off mid sentense
Open the GitHub repository (if it exists) of the current note. If you have a [multi vault](https://wiki.dendron.so/notes/24b176f1-685d-44e1-a1b0-1704b1a92ca0) workspace with different git repositories, this command will

Suggested fix, improvements or additions

will... what?

Footer on https://www.dendron.so/

Which docs page should be improved?

https://www.dendron.so/

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

The footer at the "homepage" i.e. the site found when searching on major search engines, i.e. www.dendron.so, says:

©Dendron INC 2020

It links to https://www.dendron.so/#

Suggested fix, improvements or additions

I think,

a) it should have either the current year or a year range (i.e. from invention/first commit to current year, such as 2020-2023)

b) if there is a Dendron Inc., it should link to the page of this company...

Dunno, if this is the right repo to raise the issue, so please feel free to distribute.

Best wishes,

Karsten

Updates to the Extensions page on the Dendron Wiki

The Extensions page on the Dendron Wiki should be updated.

The Dendron Snippet Maker extension is currently not included at all, either under "Bundled" or "Archived / Deprecated". As it is not bundled with Dendron, it is most likely deprecated and should be added underneath the latter heading. The Tag Search extension most likely falls under the same category.

Additionally, the content of "Other VS Code Extensions" is not displayed properly. The section only contains the error message: "Start anchor other-vscode-extensions not found".

Lastly, while the "Other VS Code Extensions" links to the Tips page, there are other recommended extensions scattered throughout the wiki. For example, the Markdown page recommends the Text Tables extension. These extensions should also be aggregated on the Extensions page.

Thank you.

How do you change dendron preview theme with custom css ?

Which docs page should be improved?

https://wiki.dendron.so/notes/0fbg5vbv5jzb0623pbi4v3t/

Which area does your issue apply to?

  • Basics: Fundamental Dendron features, installation, getting started etc.
  • Editing: Editing your notes, Markdown, frontmatter, images, templates, links, note refs, etc.
  • Retrieving: Finding your notes, lookup, lookup modifiers, etc.
  • Navigating: Navigating across notes, graph view, go to shortcuts, etc.
  • Organizing: Maintaining your notes, hierarchies, schemas, journals, tags, users, tasks, special notes, vaults, workspaces, multi-vault, etc.
  • Refactoring: Restructuring your notes, Dendron Doctor, refactor hierarchy, move/rename notes, rename header, etc.
  • Sharing: Publishing and sharing your notes, git, team workflows, etc.
  • Transferring/syncing: Importing/exporting your notes, pods, etc.
  • Extending note and workspace functionality, note type system, note traits, hooks, custom pods, etc.
  • Dendron community
  • Other (please describe in the issue description below)

What should be fixed/improved?

  • Fix outdated docs
  • Extend docs (tutorials, workflows, etc.)
  • Add docs (new features, etc.)
  • Clarification needed
  • Add/update screenshots
  • Fix broken formatting, wikilink, and/or note references
  • Other (please describe in the issue description below)

Issue description

I followed what's stated and it just doesn't do anything.

Suggested fix, improvements or additions

No response

Clean Install of Dendron Can't Initialize Workspace

Win10
VSCode 1.47.2

Trying to run the command 'Dendron: Initialize Workspace' results in the following notification:

'Command 'Dendron: Initialize Workspace' resulted in an error (command 'dendron.initWS' not found)'

Transferring Dendron notes into Microsoft Outlook emails

Add a Microsoft Outlook section somewhere, such as [[dendron.user-guide.transferring.cook]], with the following:

When adding Dendron notes into emails, sent via Microsoft Outlook, the following steps need to be done in order to maintain formatting. This will help with Markdown tables, among other features:
- In Outlook: Add the `Attach File` button to the `New Email` ribbon
- In Dendron/VSCode: `Markdown: Open Preview to the Side` (or `Ctrl+K` then `V`)
  - Save preview as HTML
- In Outlook: Click on the `Attach File` button
  - Select the HTML file that was saved
  - Click the arrow next to `Insert`, and change to `Insert as text`
  - Click to attach

The above steps should result in importing the HTML version of your Dendron note into the body of the email.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.