Skip to content

[Bug] List in remark is not rendered correctly #10559

Open
@cary-hu

Description

@cary-hu

List in remark rendered into code block, It's not expected:

Image

To Reproduce

  1. using following comment:
namespace ClassLibrary1
{
    public class Class1
    {
        /// <summary>Here is an example of a bulleted list:
        /// </summary>
        /// 
        /// <remarks>
        /// <para>Test para</para>
        /// 
        /// Test start list
        /// <list type="bullet">
        ///     <item>
        ///         <description>Item 1.</description>
        ///     </item>
        ///     <item>
        ///         <description>Item 2.</description>
        ///     </item>
        /// </list>
        /// Test end list
        /// 
        /// </remarks>
        public string TestStringProperty { get; set; }
    }
}
  1. run docfx

Expected behavior

The list should render correctly as list

Context (please complete the following information):

  • OS: Windows

  • Docfx version: 2.78.2

  • .NET version: .Net 8

  • docfx.json config

{
  "metadata": [
    {
      "src": [
        {
          "files": [
            "ClassLibrary1.dll"
          ],
          "src": "./"
        }
      ],
      "dest": "./api/ClassLibrary1"
    }
  ],
  "build": {
    "content": [
      {
        "files": [
          "api/**/*.yml"
        ]
      }
    ],
    "output": "./dest"
  }
}

Additional context

Indent code block maybe detached, Can we provide a way to disable some plugin for markdig, Remove Indent code block parse maybe help

Metadata

Metadata

Assignees

No one assigned

    Labels

    dotnetGenerate .NET API reference docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions