mirror of
https://github.com/foambubble/foam-template.git
synced 2025-06-07 20:08:54 +00:00
updated wikilink reference definition to work in github UI
This commit is contained in:
parent
9abe21993a
commit
97436ff6cb
3 changed files with 6 additions and 13 deletions
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
|
@ -16,5 +16,6 @@
|
|||
"**/node_modules": true
|
||||
},
|
||||
"vscodeMarkdownNotes.noteCompletionConvention": "noExtension",
|
||||
"vscodeMarkdownNotes.slugifyMethod": "github-slugger"
|
||||
"vscodeMarkdownNotes.slugifyMethod": "github-slugger",
|
||||
"foam.edit.linkReferenceDefinitions": "withExtensions"
|
||||
}
|
||||
|
|
2
inbox.md
2
inbox.md
|
@ -12,5 +12,5 @@
|
|||
- You can always find them in your git history, if you really need it!
|
||||
|
||||
[//begin]: # "Autogenerated link references for markdown compatibility"
|
||||
[todo]: todo "Todo"
|
||||
[todo]: todo.md "Todo"
|
||||
[//end]: # "Autogenerated link references"
|
||||
|
|
14
readme.md
14
readme.md
|
@ -27,18 +27,10 @@ We've created a few Bubbles (markdown documents) to get you started.
|
|||
- [[foam-tips]] - tips to get the most out of your Foam workspace
|
||||
- [[todo]] - a place to keep track of things to do
|
||||
|
||||
## Note on `[[wiki-links]]`
|
||||
|
||||
⚠️ Until [foambubble/foam#16](https://github.com/foambubble/foam/issues/16) is resolved, `[[wiki-links]]` links (like the links above) won't work in the GitHub Markdown preview (i.e. this Readme on github.com).
|
||||
|
||||
They should work as expected in VS Code, and in rendered GitHub Pages.
|
||||
|
||||
If GitHub preview (or general 100% support with all Markdown tools) is a requirement, for the time being you can use the standard `[description](page.md)` syntax.
|
||||
|
||||
|
||||
|
||||
[//begin]: # "Autogenerated link references for markdown compatibility"
|
||||
[inbox]: inbox "Inbox"
|
||||
[foam-tips]: foam-tips "Foam tips"
|
||||
[todo]: todo "Todo"
|
||||
[inbox]: inbox.md "Inbox"
|
||||
[foam-tips]: foam-tips.md "Foam tips"
|
||||
[todo]: todo.md "Todo"
|
||||
[//end]: # "Autogenerated link references"
|
||||
|
|
Loading…
Add table
Reference in a new issue