Skip to content

[api-documenter] Add a setting to remove breadcrumbs from the generated markdown #5177

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.

Sign up for GitHub

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

Jump to bottom
Open
niming175 opened this issue Apr 2, 2025 · 1 comment
Open

[api-documenter] Add a setting to remove breadcrumbs from the generated markdown #5177

niming175 opened this issue Apr 2, 2025 · 1 comment
Labels
enhancement The issue is asking for a new feature or design change

Comments

@niming175
Copy link

Summary

在生产的md文件中，会自动加上面包屑，请问如何去掉？
In the generated Markdown files, breadcrumbs are automatically added. How can I remove them?

Repro steps

Expected result:

Actual result:

Details

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question Answer
@microsoft/api-documenter version? 7.26.3
Operating system? Linux
Documentation target? Markdown
Would you consider contributing a PR? No
TypeScript compiler version?
Node.js version (node -v)? v20.14.0
@github-project-automation github-project-automation bot moved this to Needs triage in Bug Triage Apr 2, 2025
@octogonz octogonz added the enhancement The issue is asking for a new feature or design change label Apr 2, 2025
@octogonz octogonz changed the title [api-documenter] 在生成的md文件中，如何去掉面包屑导航 How to remove breadcrumb navigation from the generated Markdown files? [api-documenter] Add a setting to remove breadcrumbs from markdown files Apr 2, 2025
@octogonz octogonz changed the title [api-documenter] Add a setting to remove breadcrumbs from markdown files [api-documenter] Add a setting to remove breadcrumbs from the generated markdown Apr 2, 2025
@octogonz octogonz mentioned this issue Apr 2, 2025
Draft
@octogonz
Copy link
Collaborator

octogonz commented Apr 2, 2025

Here's a design proposal: #5178

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement The issue is asking for a new feature or design change
Projects
Bug Triage
Status: Needs triage
Milestone
No milestone
Development

No branches or pull requests
2 participants
@octogonz @niming175