Skip to content

Writing Documentationλ︎

Markdown is a simple and commonly used format for writing documentation. It can be used to create a project README.md to a complete guide to using the project.

LSP supportλ︎

Install Marksman plugin via Mason to provide anchor link completion.

Neovim markdown comment with todo comment Neovim markdown comment with todo comment

Static Site Generatorsλ︎

Markdown can be converted into a simple landing page or a fully navigable website.

Material for MkDocs is used by Practicalli to render professional books and blog websites.

Markdown Syntaxλ︎

# to denote a heading, the number of # defines the level of header, one # being the largest.

[name](link-url or #anchor-path) is the form for an in-page anchor and external URL

_underline text_ is surrounded by underscore character

**Bold Text** is surrounded by double star characters

Commentsλ︎

Markdown uses the HTML comment form but with three dashes rather than two.

<!--- --->

This comment also supports TODO Comments in Neovim

<!--- TODO: --->

Neovim markdown comment with todo comment Neovim markdown comment with todo comment

View TODO comments in quicklink buffer

:TODOQuickFix shows all todos within the current project in the quickfix list, each list item is used to jump to the file and line of that todo.

Tablesλ︎

Define the edges of a table with | character. :- to separate table column headings and table data.

| OS | PATH |
| :- | :--- |
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |