Docfx: The builder is not rendering note blocks NOTE, IMPORTANT, WARNING, TIP, CAUTION.

Created on 30 Dec 2018  路  3Comments  路  Source: dotnet/docfx

DocFX Version Used: 20.40.6

Template used: default

Steps to Reproduce:

  1. Initialize a project using:
docfx init -q
  1. Open the index.md file and insert a note block such as the following:
[!NOTE]
<This is a note block as shown in the DocFX tutorial page.>
  1. Build the site.

Expected Behavior:
The builder should render a corresponding HTML note block:

<div class="NOTE">
    <h5>NOTE</h5>
    <p>This is a note block as shown in the DocFX tutorial page.</p>
</div>

Actual Behavior:
The builder renders as-is plain text in the HTML file.

This behavior persists even when you change the Markdown engine from Markdig to DFM.

This behavior persists even when you drop the angled brackets as shown outside the official tutorial.

Most helpful comment

All 3 comments

You missed the starting > in each line.

Thank you guys, my bad.

Was this page helpful?
0 / 5 - 0 ratings