Skip to content

Remove TOCs in favor of GitHub outlines #2825

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

Merged
merged 1 commit into from
Jun 26, 2025
Merged

Conversation

trask
Copy link
Member

@trask trask commented Jun 22, 2025

This repo is getting flagged for vulnerabilities due to markdown-toc last being released in 2017 and so having some very old transitive dependencies.

Which made me go looking for alternatives to https://github.com/jonschlinkert/markdown-toc.

Which made me stumble on https://github.blog/changelog/2021-04-13-table-of-contents-support-in-markdown-files/ 🤯.

It's kind of unfortunate that this GitHub feature is a bit hidden (that I haven't noticed it in 4 years), maybe we need to start a publicity campaign for the feature 😄.

Overall, I think the downside is pretty minimal in this repo since there's only one markdown file with a TOC anyways (assets.md).

@trask trask added this pull request to the merge queue Jun 26, 2025
Merged via the queue into open-telemetry:main with commit 3fd3c2d Jun 26, 2025
7 checks passed
@trask trask deleted the remove-tocs branch June 26, 2025 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants