v0.32: Markdown linting
Most of this release was focused on small performance changes, but there’s one new feature for you!
Markdown format checking
Deepdwn can now check your documents for formatting consistency and errors with MarkdownLint.
Deepdwn can warn you if:
- Your headings end with punctuation
- You reversed the parentheses and brackets in your links
- Your numbered lists are out of order
- You have trailing spaces after your text
And a ton of other things. You can find a full settings reference here: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
The default settings are fairly relaxed, but you can make them as strict or as loose as you need, and many rules have additional customization options so that you can fine-tune to your liking.
All of these are configurable in
Preferences -> Advanced -> Enable markdown format warnings. There’s a simple configuration setting in JSON format currently, but that may be changed in a future release.
Deepdwn has a couple of custom rules, based on the default markdownlint rules:
no-trailing-punctuation-folding, which is identical to
no-trailing-punctuationbut accepts an option to ignore folding indicators, “…”, at the end of headings, instead of treating them like normal punctuation.
ol-prefix-orderwhich is identical to
ol-prefixbut allows ordered lists to start with any number when using the
I’m hoping to add an interface to let you fix many of these in one click in a future update.
- Load the last active file earlier in the startup process to reduce the time until file is visible. Most significant for large file collections.
- Reduce work done while parsing tags and categories while typing.
- Reduced background work when selecting tags and resizing window panels.
- Reduced foreground work while processing links to headings between files
- Reduced config file writing for some repeated operations
- Move markdown linting to a background process to reduce impact while editing
- Mac users now use the Command key, rather than Ctrl, to select multiple tags in the tag list.
- In the preview, abbreviation text decoration (a dotted underline) has a little more visual space
- Minor formatting changes for the example document
- Change lint error and warning icons (previously only visible for errors in document yaml metadata)
- Lint warning popups now use bold text for the first line
- IDs for headings are now generated before applying typographic changes (ex: changing single quotes to curly quotes), resulting in simpler and more predictable heading links. Unfortunately, this may mean that you need to regenerate some links to headings in your existing documents if they were affected. Sorry about that!
- Fixed deselected tags becoming reselected after exiting and relaunching Deepdwn.
- Block quotes in light mode now have a different font color. This was already the case in dark mode
- With big headings enabled, the space between headings and heading prefixes,
###, are more consistent and constrained
- Lint popups in high-contrast mode now use a thicker border, more consistent with the rest of the mode
- Fixed autocompleting links to headings sometimes showing HTML in plain text, depending on heading formatting
- Fixed being unable to use link autocomplete from unsaved documents. Headings from the current file are now supported