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

FEAT: Auto-Generate Table of Contents for markdown (README.md, contributing.md, blog pages, and more!) #138

Open
1 of 2 tasks
helmturner opened this issue Oct 31, 2022 · 0 comments
Labels
ci/cd infrastructure / automation documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@helmturner
Copy link
Collaborator

helmturner commented Oct 31, 2022

Note: for support questions, please use #ug-code-for-tulsa slack channel in Techlahoma or stackoverflow. This repository's issues are reserved for feature requests and bug reports.

  • I'm submitting a ...

    • bug report
    • feature request
  • What is the current behavior?

There's no way of automatically generating Table of Contents from markdown files.

Not a bug.

  • What is the expected behavior?

When a commit makes changes to markdown files, a Table of Contents complete with links is generated form the headings and sub-headings in the document and inserted at a location determined by the file's author.

  • What is the motivation / use case for changing the behavior?

I don't want to update the Table of Contents every time I add new documentation, but it would also be really cool for Blog pages to have a ToC auto-magically!

  • Please tell us about your environment:

    • Version: n/a
    • Browser: n/a
    • Language: n/a
  • Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)

This should do the trick!

@helmturner helmturner added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers ci/cd infrastructure / automation labels Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/cd infrastructure / automation documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
Status: Backlog
Development

No branches or pull requests

1 participant