1. Markdown Tips

1.1 VSCode Shortcuts

VSCode is pretty handy for editing Markdown. Here are some tips:

• Press ⌃Space (Trigger Suggest) while editing to see a list of suggested Markdown snippets
• Use ⇧⌘O to quickly jump to a header in the current file.
• Use ⌘T to search through headers across all Markdown files in the current workspace
• Path suggestions are automatically shown when you type / or can be manually invoked by using ⌃Space.
• You can Drag and drop a file from VS Code's Explorer or from your operating system into a Markdown editor. Start by dragging a file from VS Code's Explorer over your Markdown code and then hold down Shift to start dropping it into the file.
• Previews: To switch between views, press ⇧⌘V in the editor. You can view the preview side-by-side (⌘K V) too

1.1.1 See also

• Official vscode help

1.2 MKDocs material

Material for mkdocs is a framework for rendering markdown based documentation.

This website uses it for turning a collection of markdown notes into an HTML website.

1.2.1 Admonitions

See the Material admonitions documentation. E.g.:

!!! note "Phasellus posuere in sem ut cursus"

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

??? note

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

Supported types

abstract
info
tip
success
question
warning
failure
danger
bug
example
quote