Skip to content

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

@helmturner

Description

@helmturner

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    ci/cdinfrastructure / automationdocumentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomers

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions