Markdown
Markdown is a lightweight markup language with plain text formatting syntax. Docfx supports CommonMark compliant Markdown parsed through the Markdig parsing engine.
Markdown Extensions
Docfx supports additional markdown syntax that provide richer content. These syntax are specific to docfx and won't be rendered elsewhere like GitHub.
To use a custom markdown extension:
- Use docfx as a NuGet library:
<PackageReference Include="Microsoft.DocAsCode.App" Version="2.61.0" />
- Configure the markdig markdown pipeline:
var options = new BuildOptions
{
// Enable custom markdown extensions here
ConfigureMarkdig = pipeline => pipeline.UseCitations(),
}
await Docset.Build("docfx.json", options);
Here is a list of markdown extensions provided by docfx by default.
Alerts
Alerts are block quotes that render with colors and icons that indicate the significance of the content.
The following alert types are supported:
> [!NOTE]
> Information the user should notice even if skimming.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Essential information required for user success.
> [!CAUTION]
> Negative potential consequences of an action.
> [!WARNING]
> Dangerous certain consequences of an action.
They look like this in rendered page:
Note
Information the user should notice even if skimming.
Tip
Optional information to help a user be more successful.
Important
Essential information required for user success.
Caution
Negative potential consequences of an action.
Warning
Dangerous certain consequences of an action.
Video
You can embed a video in your page by using the following Markdown syntax:
> [!Video embed_link]
Example:
> [!Video https://www.youtube.com/embed/Sz1lCeedcPI]
This will be rendered as:
Include Markdown Files
Where markdown files need to be repeated in multiple articles, you can use an include file. The includes feature replace the reference with the contents of the included file at build time.
You can reuse a common text snippet within a sentence using inline include:
Text before [!INCLUDE [<title>](<filepath>)] and after.
Or reuse an entire Markdown file as a block, nested within a section of an article. Block include is on its own line:
[!INCLUDE [<title>](<filepath>)]
Where <title>
is the name of the file and <filepath>
is the relative path to the file.
Included markdown files needs to be excluded from build, they are usually placed in the /includes
folder.
Code Snippet
There are several ways to include code in an article. The code snippet syntax replaces code from another file:
[!code-csharp[](Program.cs)]
You can include selected lines from the code snippet using region or line range syntax:
[!code-csharp[](Program.cs#region)]
[!code-csharp[](Program.cs#L12-L16)]
Code snippets are indicated by using a specific link syntax described as follows:
[!code-<language>[](<filepath><query-options>)]
Where <language>
is the syntax highlighting language of the code and <filepath>
is the relative path to the markdown file.
Highlight Selected Lines
Code Snippets typically include more code than necessary in order to provide context. It helps readability when you highlight the key lines that you're focusing on. To highlight key lines, use the highlight
query options:
[!code-csharp[](Program.cs?highlight=2,5-7,9-)]
The example highlights lines 2, line 5 to 7 and lines 9 to the end of the file.
Tabs
Tabs enable content that is multi-faceted. They allow sections of a document to contain variant content renderings and eliminates duplicate content.
Here's an example of the tab experience:
The above tab group was created with the following syntax:
# [Linux](#tab/linux)
Content for Linux...
# [Windows](#tab/windows)
Content for Windows...
---
Tabs are indicated by using a specific link syntax within a Markdown header. The syntax can be described as follows:
# [Tab Display Name](#tab/tab-id)
A tab starts with a Markdown header, #
, and is followed by a Markdown link []()
. The text of the link will become the text of the tab header, displayed to the customer. In order for the header to be recognized as a tab, the link itself must start with #tab/
and be followed by an ID representing the content of the tab. The ID is used to sync all same-ID tabs across the page. Using the above example, when a user selects a tab with the link #tab/windows
, all tabs with the link #tab/windows
on the page will be selected.
Dependent tabs
It's possible to make the selection in one set of tabs dependent on the selection in another set of tabs. Here's an example of that in action:
.NET content for Linux...
Notice how changing the Linux/Windows selection above changes the content in the .NET and TypeScript tabs. This is because the tab group defines two versions for each .NET and TypeScript, where the Windows/Linux selection above determines which version is shown for .NET/TypeScript. Here's the markup that shows how this is done:
# [.NET](#tab/dotnet/linux)
.NET content for Linux...
# [.NET](#tab/dotnet/windows)
.NET content for Windows...
# [TypeScript](#tab/typescript/linux)
TypeScript content for Linux...
# [TypeScript](#tab/typescript/windows)
TypeScript content for Windows...
# [REST API](#tab/rest)
REST API content, independent of platform...
---