Markdown
Interesting and advanced features of Markdown 👇
- Table of Content generation w/
<!-- omit in toc -->
to ignore first-level heading. - Image positioning: side-by-side, text-wrap, full-width.
- Markdown Lint rules enforcing.
- Footnotes
[^1]
- Frontmatter allows you to specify metadata and options about how your project should behave or render.
- Code Block language convention starting with
bash
orpy
orjs
- Table formatting w/ Markdown All in One VS Code extension.
- File Naming Convention… for convenient date sorting 👉 How do you control the order in which files appear in a GitHub gist 👀
Recommended VS Code extensions ⚙️
markdownlint Markdown linting and style checking for Visual Studio Code scripts. | |
---|---|
Markdown All in One All you need to write Markdown (keyboard shortcuts, table of contents, auto preview and more. | |
GitHub Markdown Preview Changes VS Code's built-in markdown preview to match GitHub. This is an extension pack of the following VS Code markdown preview extensions. | |
:emojisense: Adds suggestions and autocomplete for emoji. |
Recommended VS Code extensions in ~/GitHub/<owner>/<repo>/.vscode/extensions.json
👇
{
"recommendations": [
"bierner.emojisense",
"davidanson.vscode-markdownlint",
"yzhang.markdown-all-in-one",
"bierner.github-markdown-preview",
]
}
Review your VS Code settings in 👇
~/GitHub/<owner>/<repo>/.vscode/settings.json
~/Library/Application Support/Code/User/settings.json
Note, Tip, Warning
[!NOTE] Please note that…
Note
Please note that…
Tip
If you wish to…
> [!TIP]
> If you wish to...
Warning
When using…
> [!WARNING]
>
> 1. When using...
> 2. This step is crucial as it ensures your database is properly mounted and prevents any loss of data.
References 📚
- Markdown and Visual Studio Code several Markdown-specific features that help you be more productive.
- GitHub Flavored Markdown Style Guide to create sophisticated formatting for your prose and code on GitHub with simple syntax ✍️
- Markdown Syntax by John Gruber co-creator of the Markdown markup language 🖋️
- Markdown Tutorial - En Français 🇫🇷
Sponsorship
If this project helps you, you can offer me a cup of coffee ☕️ :-)