Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
cary-hu opened this issue Feb 25, 2025 · 1 comment
Open

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

cary-hu opened this issue Feb 25, 2025 · 1 comment
Labels
dotnet Generate .NET API reference docs

Comments

@cary-hu
Copy link

cary-hu commented Feb 25, 2025

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

@cary-hu cary-hu added the dotnet Generate .NET API reference docs label Feb 25, 2025
@filzrev
Copy link
Contributor

filzrev commented Feb 25, 2025

I’ve confirmed it can be reproducible on my environment (Windows/docfx v2.78.2/.net8 SDK 8.0.406)
It seems be occurred when generating API metadata from DLLs. (It's not happens when generating metadata from source code)

As a temporary workaround. it can avoid problems by wrapping Test start list with <para></para> tags.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet Generate .NET API reference docs
Projects
None yet
Development

No branches or pull requests

2 participants