[Feature Request] Make <a/> tag in headers optional when outputFormat: markdown
- Dominant language
- C#
- Stars
- 4.4k
- Forks
- 890
- Avg merge
- 2h 11m
- Merged PRs (30d)
- 10
Description
**Describe the bug**
A rendered markdown file includes an empty `` tag in the markdown H1 title.
For example:
```
# Delegate CustomBinding0
```
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
```json
{
"metadata": [
{
"src": [
{
"src": "..",
"files": [
"**/*.cs"
]
}
],
"dest": "api",
"globalNamespaceId": "Global",
"allowCompilationErrors": true,
"namespaceLayout": "nested",
"outputFormat": "markdown"
}
]
}
```
**Expected behavior**
If rendering this empty `` 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.
Contributor guide
Assessment
This issue has not been assessed yet.