dendronhq / dendron

The personal knowledge management (PKM) tool that grows as you do!
https://wiki.dendron.so
Apache License 2.0
6.66k stars 252 forks source link

Ignore specific cases of wikilinks not meant to be treated as wikilinks by Dendron (ex. [[_TOC_]] for GitLab and Azure DevOps Wiki) #2613

Open ScriptAutomate opened 2 years ago

ScriptAutomate commented 2 years ago

Please select if your request is either something new or an enhancement

Please select the area your request applies to. (Multiple selections are Possible. You can leave blank if you're not sure.)

Is your feature request related to a problem? Please describe

When using certain Wiki endpoints, like GitLab or Azure DevOps Wiki, there are reserved keywords that specially render Markdown. In this specific use case, I'm talking about [[_TOC_]].

If wanting to export Dendron notes as Markdown files to be used by these systems, Dendron will treat [[_TOC_]] as a Dendron flavored wikilink that it needs to convert. This means that, at the moment, special features like [[_TOC_]] can't be used easily in Dendron notes due to Markdown exporting treating it like a link to a Dendron note.

Describe the solution you'd like

It's almost like we'd want some kind of convertLinkIgnore list in the Markdown export pod config, and it could function similar to how a .gitignore file does for git: ignore these at conversion time, and let them remain as they are.

Describe alternatives you've considered

An alternative could be to extend the Dendron frontmatter to insert [[_TOC_]] into the note when a Markdown export is occurring. This would be helpful in that Dendron wouldn't see [[_TOC_]] as a broken Dendron link, and the link would only be inserted at time of Markdown file conversion. That, or a note-specific list of wikilinks to ignore as being wikilinks?

Additional context

This may be requesting a new feature, rather than enhancing an existing one. I wasn't sure the best way to label it.

jenquist commented 2 years ago

👍👍 I would find this very useful!

ScriptAutomate commented 2 years ago

@jenquist +1+1 I would find this very useful!

I suppose workaround, in meantime, would be something like using TOC_PLACEHOLDER and then doing a recursive file modification in the exported dir tree to replace all TOC_PLACEHOLDER values with [[_TOC_]]