Skip to content

[Feature Request] Make <a/> tag in headers optional when outputFormat: markdown #9720

Description

@bohyunjung

Describe the bug

A rendered markdown file includes an empty <a/> tag in the markdown H1 title.
For example:

# <a id="Newtonsoft_Json_Generated_CustomBinding0_4"></a> Delegate CustomBinding0<TSelf, T0, T1, T2\>

Is this rendered for a reason, or is it a bug? What is the role of this element?

To Reproduce
Steps to reproduce the behavior:

Run docfx with metadata.outputFormat: "markdown" option.

Whole docfx.json
{
  "metadata": [
    {
      "src": [
        {
          "src": "..",
          "files": [
            "**/*.cs"
          ]
        }
      ],
      "dest": "api",
      "globalNamespaceId": "Global",
      "allowCompilationErrors": true,
      "namespaceLayout": "nested",
      "outputFormat": "markdown"
    }
  ]
}

Expected behavior

If rendering this empty <a/> element is unnecessary, I expect this not to be included in the markdown file.

Context (please complete the following information):

  • OS: macOS 14.2.1(23C71)
  • Docfx version: 2.75.3+a5c719410037cc288c7adff010b1abf3c0f2e581
  • Dotnet version: 7.0.403

Additional context

I'm working on a Unity package project, and I referenced the docfx settings of https://github.com/CaseyHofland/docfx-unitypackage.

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