GitHub's Extended Syntax Reference
- Header in current file
[text](#_some-header)
- To another file
[text](/path/to/file.md)
- Header in another file
[text](otherFile.md#other-header)
- Ref links (links saved in variable)
[link-id]: https://www.google.com
[text][link-id] - Create vscode link validation exceptions
- In settings.json add "markdown.validate.ignoredLinks"
- Right click file
- Click
Open with... - Click
Change default editorat the bottom of the pop up
-
Rename markdown headers and all its links: right click header ->
Rename symbol -
Paste link on selected text for link auto format
-
> Create table of contentsauto creates table of contents for file -
Change styling of markdown preview
"markdown.styles": [ "/home/chris/Documents/Code/current/markdown-preview.css", //Linux "C:\\Users\\chris\\Documents\\Code\\current\\markdown-preview.css" //Windows ],
- Open preview
ctrl+shift+v
- Go to header in file `ctrl+shift+o` - Bold `ctrl+b` - Check mark `alt+c`
- Quick change to bullets `ctrl+m ctrl+b` - Quick change to numbers `ctrl+m ctrl+1` - Quick change to checkboxes `ctrl+m ctrl+x`
NOTE: VSCode already comes with a markdown preview and editor.
- Markdown Extension Pack (bat67.markdown-extension-pack)
Includes:
- Markdown All in One
- Markdown Checkboxes
- Markdown Emoji
- Markdown Paste
- Markdown Pdf
- Markdown Preview Enhanced
- Markdown Preview GitHub Styling
- Markdown Shortcuts
- Markdown Table Prettifier
- Markdown+Math
- markdownlint
- enforces a library of rules to encourage standards and consistency for Markdown files
- helps prevent common markdown mistakes
- Can have VSCode ignore certain rules in settings.json
"markdownlint.config": {"MD033": false,},
https://daringfireball.net/projects/markdown/basics