Link Search Menu Expand Document

Changelog

0.36.2

Bug Fixes

  • multiple notes created when clicking on a link with an alias

0.36.1

Bug Fixes

  • Multiple notes created when opening a note via the treeview

0.36.0


0.35.2

Features

Goto Note command

  • shortcuts:
    • key: ctrl+enter
    • when: editorFocus

Goto to the note under the cursor, creating it if it doesn't exist.

  • NOTE: this fixes issue 564 which causes a new note to be created on hover when combined with noAutoCreateOnDefinition set to true. We introduced noAutoCreateOnDefinition configuration to help folks transition to the new behavior. Auto creating on definition will be deprecated in a future release

Enhancements

  • better details in diagnostics report
  • support xvault backlinks
  • faster backlink generation
  • include content from unpublished notes (docs)
    • this allows you to use note references to hierarchies that aren't explicitly published
  • better Theia compatibility

Bug Fixes

  • disable auto-creation notes on definition (docs)

0.35.1

Features

Add and Commit

Add and commit all notes across all vaults to git.


Enhancements

  • useNoteTitleForLink now true by default
  • control hierarchy display using note frontmatter (docs)
  • ability to disable appending uuid's to assets when importing markdown (docs)
  • ability to set an index file when importing markdown (docs)

Bug Fixes

  • bulk importing notes would fail if payload was greater than 10mb
  • punchcard pod referring to wrong commit

Docs

0.35.0


0.34.1

Features

A Better Doctor

Dendron doctor has been updated with a bunch of new options including the ability to migrate old style refs to new style refs

  • shortcuts: none

Auto fix various issues with Dendron. You can pick among various actions for the doctor to perform

Actions

  • fixFrontmatter
    • add ids and titles to the frontmatter of all notes that are missing it
    • setup a docs folder if it doesn't exist. Required if you want to publish your notes

  • h1ToTitle: remove initial h1 header and use it to replace contents of title field in frontmatter
  • h1ToH2: convert all initial h1 header to h2 header
  • removeStubs: remove all stub docs
  • oldNoteRefToNew: convert legacy note refs to new style note refs

Enhancements

  • support hiding hierarchy view on published page (docs)
  • GitPunchcard support multi-vault (docs)
  • support toggling vault initialization behavior at startup (docs)
  • support migrating old note refs to new note refs (docs)

Bug Fixes

  • correct hiearchyDisplayTitle to hierarchyDisplay option (BREAKING)
  • fix spurious getVault errors

House Cleaning

  • removed all old style refs from dendron-site
  • formal deprecation notice for old style refs (((ref: )) syntax) - they will be removed in the next release. use doctor to upgrade

0.34.0


0.33.1

Features

Browse Current File

  • shortcuts: None

Open the github repository (if it exists) of the current note. If you have a multi vault workspace with different git repositories, this command will

Enhancements

  • wikilinks to missing vaults will display an error instead of throwing one
  • ability to disable legacy refs (docs)
  • add xkcd to vault presets (docs)
  • 5x faster markdown pod import using plugin 🚀 🚀 🚀
  • toggle katex settings from config (docs)

Bug Fixes

  • displaying children hierarchies fails on stub notes
  • empty query doesn't display all root nodes when multi-vault

0.33.0


0.32.2

Features

Markdown Export

The export markdown pod will take Dendron markdown and convert it to regular markdown. Dendron specific markup like wikilinks and note refs will be converted to their markdown equivalent (regular md link and inlining the note ref content as markdown).

GitPod

  • type: export

Create a vega punchard visualization of your commits. This will output two files at the destination:

  • commits.csv
  • index.html

You can then see this using a HTML server.

  • Instructions:
dendron exportPod  --wsRoot . --podId dendron.gitpunchard --config "dest=/tmp/vega" 
cd /tmp/vega
python -m http.server

Enhancements

  • disable git linking on a per note basis (docs)
  • set a custom path for git url (docs)
  • dendron-cli is now named dendron (dendron-cli will continue to work)
  • buildSiteV2 has been renamed to buildSite (buildSiteV2 will continue to work but is now considered deprecated)
  • add tldr to remote vault presets (docs)
  • support useFMTitle when publishing to markdown
  • fix link textwrap issue when publishing for mobile

House Cleaning

  • consolidate engine-server and common-server tests into engine-test-utils

0.32.1

Features

Password protected sites

You can now use managed publishing with a password. Note that you'll need sprout membership to use the feature.

Enhancements

  • control display for children links (docs)
  • skipLevels also applies to children lins
  • useNoteTitleForLink also applies to note references
  • importing from markdown is now 5x faster 🚀🚀🚀
    • NOTE: this is only for the CLI
  • a bunch of new options when importing a pod (docs)
  • show progress bar when importing pod from plugin

Bug Fixes

  • dendron will check if dependencies are actually installed before trying to preview your site
  • remove un-used extensions
  • failure when importing large amounts of markdown files using import pod

House Cleaning

  • importing a pod now requires a vaultName parameter (previous, we just defaulted to the first vault)

0.32.0


0.31.3

Features

Changelogs

  • status: 🚧

Dendron can now generate a changelog for your published site. Note that this feature is currently experimental and will only generate the changelog for your latest commit. It also requires that you be using git to store your notes. When enabled, this will add Changelog to your nav bar which will have your most recent commit.

House Cleaning

  • all tests are now jest style tests

0.31.2

Features

Custom Domain Names

Dendron now supports custom domain names for managed publishing. You can find docs here. Note that this feature is currently limited to environmentalist .

Enhancements

  • Add paste link command (docs)
  • don't throw fatal error on bad wikilink
  • don't throw fatal error if siteUrl not set while in dev
  • add remark-containers plugin docs

Bug Fixes

  • refs don't include children or backlinks
  • clean dendron.yml after removing a vault

0.31.1

Bug Fixes

  • issue with mixed case file names

0.31.0


0.30.2

Features

Cross vault links are a way of exactly specifying a note in a multi vault workspace. You can turn a regular link into a cross vault link by adding dendron://$vaultName/ prefix where $vaultName is the name of your vault.

Some examples:

  • regular wiki link: [[dendron://vault/foo]]
  • wiki link with alias: [[Foo Note|dendron://vault/foo]]
  • relative link: [[Foo Note|dendron://vault/foo#header1]]

You can also use cross vault links for note references.

  • note ref: ![[dendron://vault/foo]]

Enhancements

  • you can now add a workspace when adding a remote vault (docs)
  • better block quotes (docs)
  • better formatted backlinks on published pages
  • backlinks display using note title instead of file names
  • copy note commands will create a cross vault link when in multi-vault environment

Bug Fixes

  • selecting non-primary root note in dendron tree
  • bad backlinks created for home page
  • issue with hierarchies for mixed case parents

Documentation

  • new docs on using dendron for blogging

House Cleaning

  • table of contents on published sites is now a remark extension, header changed to children
  • jekyll publishing has been renamed to legacy publishing
  • lots of internal refactoring of code

0.30.1

Features

Custom Pods

We now have custom pod support

Custom pods can be developed by anyone as a NodeJS package and used after a user installs it in their workspace. They can be used with either the dendron-cli or from within the Dendron extension to import/export/publish your notes from/to anywhere

  • NOTE: at the current time, custom pods can only be run using dendron-cli. We're working on building them into the plugin within the next couple of weeks
  • NOTE: currently, only custom pods for publishing is supported. We're working on adding support for import and export pods

If you are interested in developing your own publishing pod, you can docs to do so here

Dev.to Pod

As an example of what you can do with a custom pod, we created the Dev.to Pod which lets you publish your notes to dev.to

Enhancements

  • backlinks in published sites

This is the equivalent to the backlinks panel when using the desktop app.

Backlinks are automatically deduped and also work in a multi-vault setting.

Bug Fixes

  • delete node sometimes fails in multi-vault
  • publishing multi-vault will sometimes not work if multiple domain notes
  • unable to select root of multi-vault notes in tree view

House Cleaning

  • if you're working on the codebase, dendron.code-workspace has been renamed to dendron-main.code-workspace
    • this helps if you're working on dendron while having dendron installed since Dendron, prior to this change, would also activate when you were editing the code

0.29.2

Features

Experimental Nunjuck Templates

Extremely powerful templating capabilities with nunjuck templates

Enhancements

  • better multi-vault defaults
    • instead of keeping remote vaults under a special repos folder, you can now initialize them where ever you want
  • better git defaults with new vaults

Bug Fixes

  • support turning off pretty refs for dendron preview (docs)

0.29.1

Enhancements

  • private vaults (docs)
  • popover 403 links (docs)
  • standardize pod cli interface

Bug Fixes

  • use builtin clipboard manager
  • private wiki links render errors on published page

House Cleaning

0.28.1

Features

Managed Publishing (Early Preview)

The initial release comes with the ability to publish a dendron workspace under {username}.dendron.wiki. Dendron takes care of configuring your domain and building your site.

After you connect your github repo with Dendron, we'll kick off the initial publication. Every subsequent time you push to your repo, Dendron will automatically build your site with the latest changes.

At launch, we are supporting publishing from a connected github repo. Instructions to get started are here

Enhancements

  • show last modified time for published sites (docs)
  • add option to configure human readable ts formatting (docs)
  • smaller downloads when using publishing commands for the first time
  • much faster publishing commands
  • frontmatter can now be folded

Bug Fixes

  • 11ty build issues
  • dendron move note command can fail when parents are stubs
  • preview can get out of sync with Dendron

House Cleaning

  • dendron monorepo is now on yarn
    • this results in 4x faster initial builds and 6x smaller bundle sizes when developing
  • dendron-11ty is now merged into the dendron monorepo

If you currently have Dendron checked out, you can use the following instructions to migrate

# get latest version
git pull

npm install -g yarn
# remove old node_modules
./bootstrap/scripts/cleanup.sh
yarn bootstrap:bootstrap
yarn bootstrap:build 

0.27.2

Features

  • diagnostics report (docs)

  • shortcuts: none

Copy last 3000 lines of all logs and config to clipboard. Use when submitting an issue to Dendron

Enhancements

  • add path customization to build-site (docs)
  • Add default description option to dendron config (docs)
  • add config to publish multi-vault when adding vault (docs)

Bug Fixes

  • build-site doesn't overwrite STAGE environment
  • do not delete text when extracting non-vault text
  • add new vaults to newline in .gitignore

0.27.1

Bug Fixes

  • server close error when building website for production

0.26.1

Features

  • move notes between vaults using the move note command (docs)

Enhancements

  • nicer 403 page on unpublished pages (docs)

Bug Fixes

  • issue with daily journal notes not getting pretty titles
  • ctrl hover over images will create a note
  • when removing a note with empty parents, clean up empty parents

0.25.3

Features

  • mermaid diagram support when publishing (docs)
  • display note title as link (docs)

Enhancements

  • use list of vaults when resolving duplicate notes (docs)
  • go to definition now works for ![[refs]]
  • Copy Note Link now updates alias to header value when copying header

Bug Fix

  • grammar issue with unpublished page notification

House Cleaning

  • remove sync_vault as a step when building dendron for the first time

0.25.2

Bug Fix

  • issue with new vaults not having welcome note

0.25.1

Bug Fix

  • issue with md outline not showing

0.24.2

Features

Site Build and Preview built-in to extension

You can now publish and build your notes without going to the command line (docs)

Enhancements

  • show progress bar when syncing graph
  • show progress bar when installing node modules
  • useFMTitle set to true by default
  • add .gitignore to newly created workspace
  • Copy Note Url uses siteUrl as value for noteRef

Bug Fixes

  • fix issues with nav capitalization
  • fix dup items in nav
  • windows site preview not cleaning up child processes
  • fix note graph errors

Docs

  • revamped publishing docs

House Cleaning

0.24.1

Features

Enhancements

Bug Fixes

  • fix multi-vault breadcrump null issue
  • fix windows build for site

0.23.2

Features

Enhancements

  • better 403 page (docs)
  • spurious error message if user doesn't create note from not selecting a vault
  • better default journal note titles

Bug Fixes

  • issue publishing with subdomain
  • some queries not being returned in multi-vault settings
  • issue with noteRef mangling when using doctor

House Cleaning

0.23.1

  • Dendron Markdown Preview: 0.10.18
  • Dendron 11ty: 1.23.6

Features

Updated Note Ref Syntax

You can now do references to notes using ![[note]] instead of ((ref: [[note]])) syntax. To reference a header, use ![[note#foo]]. This changes makes our note ref syntax more consistent with our wiki link syntax.

Note that the new ref syntax expects a sluggified header. This is done automatically when you use the updated copy note ref command.

This change makes it possible to create a ref to a header with special characters.

The old syntax ref syntax will still work but should now be considered deprecated. We will release a doctor command to help you auto-upgrade from the old syntax to the new syntax in the coming week.

Frontmatter Variable Substitution

It is now possible to use variables defined in your note frontmatter inside your note. The syntax is {{fm.VAR_NAME}} where VAR_NAME is the name of your variable. The fm designates that you want to use a frontmatter variable.

Enhancements

  • nav_exclude property excludes from nav sider and table of contents (docs)
  • copy note ref command will use the new note ref syntax
  • footnote support in preview and when publishing (docs)

Bug Fixes

  • spaces in wiki link not rendering in preview

0.22.2

Enhancements

  • better fuzzy search for lookup
  • publishing v2 enhancements
    • abbreviation support for 11ty publishing (docs)
    • better note titles (docs)
    • shrink size of published page 10x
    • fix left nav position of current active page
    • ability to override output folder from CLI when building site
    • don't throw error on code blocks that are unsupported by prismjs

Bug Fixes

  • markdown preview delay in showing newly created notes
  • buildSiteV2 not connect to running workspace

0.22.1

Features

  • Collections support for 11ty
    • publish blog like archives using Dendron
  • CLI Based Doctor (docs)
    • run various tests to make your notes are healthy for the new year
  • use frontmatter as title when publishing and in the preview (docs)

Enhancements

  • additional metadata tags for published pages
  • support noindex option (docs)
  • add anchor links to headers
  • use note title for page title
  • support nav_exclude option
  • support overriding output in buildSiteV2 command
  • don't throw error if no syntax highlighter available for code block

Bug Fixes

  • issue connecting to open workspace using CLI
  • nav bar when publishing multiple hierarchies will show wrong expansion options

0.21.2

Enhancements

  • build-site command can connect to current running workspace (docs)
  • support inline math when publishing
  • support block math when publishing
  • support rendering gfm inside note reference when publishing
  • support anchor headings when publishing
  • support relative links when publishing

Bug Fixes

  • issue with displaying math in preview

House Cleaning

  • the code highlighter has been changed from prismjs to highligher.js

0.21.1

Enhancements

  • add seo tags (docs)
  • enable edit on github link (docs)
  • migrate all jekyll _config.yml settings to dendron.yml

Bug Fixes

  • build-site errors when building from vaults without asset folder
  • build-site error on certain operating systems
  • build-site error on node version != 12

Docs

0.20.2

Features

Publishing For Multi Vault

Publishing

You can publish from a multi-vault enabled workspace if you are using dendron-11ty to publish.

We have added a new configuration, duplicateNoteBehavior, which controls how Dendron handles duplicate notes across multiple vaults.

Enhancements

  • creating engine via cli also initializes meta files (d72f097)(docs)
  • remove github light theme from dendron bundle (33d5708)
  • support note refs for multi-vault
  • support relative links in dendron preview (docs)
  • further speed enhancements to publishing using 11ty resulting in another 5x improvement
  • configure writeStubs from dendron.yml

Bug Fixes

  • refactor hierarchy miss self referential links (00b385d)
  • reduce frequency of engine not connecting error when launching dendron preview

House Cleaning

  • writeStubs is set to true by default (or when not set) when publishing using 11ty

0.20.1

Publishing V2 (preview)

We've re-build publishing for Dendron from the ground up to be faster, better, and easier to use.

Besides for schemas, publishing has consistently been one of the hardest to use features in Dendron. Dendron currently publishes using jekyll using our own template. While this has served as well initially, slow compile times for large sites and difficulty of getting started has made it a growing pain point.

To address this, we've migrated our publishing stack to 11ty, a super fast javascript based static generator. This means much faster, and perhaps more importantly, easier publishing.

There's still some work left to integrate publishing into the Dendron plugin - meanwhile, you can take the new publishing workflow for a spin using the dendron cli

In order to to use the 11ty based publishing, initialize your workspace with the following commands.

npm init -y
npm install @dendronhq/dendron-cli@latest
npm install @dendronhq/dendron-11ty@latest

After you have your dependencies installed, build your your site using the following command.

npx dendron-cli buildSiteV2 --wsRoot .  --stage dev --serve

This will both compile your site locally and make it available at localhost:8080 for instant preview. When building your site locally, the pages will be build to {wsRoot}/build/site.

When you are ready to publish to github, make sure to change the stage to prod.

npx dendron-cli buildSiteV2 --wsRoot .  --stage prod 

This will build your site to the path specified by siteRootDir in dendron.yml.

Benchmarks

Publishing V2 is ~10x faster than jekyll based publishing for sites with +100 pages. For comparison, below is the compilation difference between building the dendron site using 11ty vs jekyll.

  • 11ty: 24.45s
  • jekyll: 220.33s

There are additional optimizations still on the table that will further drive down he compilation time by another order of magnitude for future releases.

Gaps

11ty publishing is currently not at full feature parity with Jekyll publishing. Notably, the following features are missing:

  • setting a custom color theme
  • edit on github links
  • jekyll-seo functionality
  • mathjax

Migration

All values that used to be written into _config.yml will now be moved into dendron.yml. You can see the currently supported configuration values here: https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/types.ts#L71:L71

If you currently have a Jekyll based Dendron page, note that the following settings have changed:

  • the url property from _config.yml is now siteUrl in dendron.yml
  • favicon is now controlled by siteFaviconPath in dendron.yml and is a path relative to your workspace root
  • CNAME is now controlled by githubCname property in dendron.yml

Sample dendron.yml config

  • publishing without a cname
version: 1
vaults:
    - fsPath: vault
site:
    copyAssets: true
    siteHierarchies:
        - dendron
    siteRootDir: docs
    siteUrl: "kevinslin.github.io/dendron-11ty-test"
    usePrettyRefs: true
  • using custom cname
version: 1
vaults:
    - fsPath: vault
site:
    copyAssets: true
    siteHierarchies:
        - dendron
    siteRootDir: docs
    usePrettyRefs: true
    siteUrl: "11ty.dendron.so"
    githubCname: "11ty.dendron.so"

Sample repo

CLI Command Reference

dendron-cli buildSiteV2

build notes for publication using 11ty

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]
  --wsRoot   location of workspace                                    [required]
  --vaults   location of vault                                           [array]
  --serve    serve over local http server             [boolean] [default: false]
  --stage    serve over local http server

Past Releases


Children

  1. -01.x
  2. 0.1.X