change: quote default literatureNoteContentTemplate#126
Open
eddieantonio wants to merge 1 commit intohans:masterfrom
Open
change: quote default literatureNoteContentTemplate#126eddieantonio wants to merge 1 commit intohans:masterfrom
eddieantonio wants to merge 1 commit intohans:masterfrom
Conversation
The default value of `literatureNoteContentTemplate` will generate YAML front matter that is often broken by special YAML characters. For instance, a colon (`:`) in the {{title}} will cause a syntax error in YAML. This adds quotes around both `{{title}}` and `{{authorString}}` in an attempt to remedy the easily-broken default.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The default value of
literatureNoteContentTemplatewill generate YAML front matter that is often broken by special YAML characters. For instance, a colon (:) in the {{title}} will cause a syntax error in YAML. This adds quotes around both{{title}}and{{authorString}}in an attempt to remedy the easily-broken default.For example, I created a literature note which contains a colon in the title. This is the result using the previous default template:
(try this snippet in YAML Lint!)
Obsidian presents this as "Metadata (invalid YAML)" in the preview:
After the change, the front matter is as follows:
After this change, the default is no longer broken by the titles containing colons or other YAML syntax.
Note: this may be considered a breaking change, as it changes the defaults of the plugin.
Fixes #117
Addresses #89