search

cannawen / metric_units_reddit_bot

Reddit bot converting imperial units to metric units
https://www.reddit.com/user/metric_units
GNU General Public License v3.0
78 stars 34 forks source link

Generate table of contents for README.md and CONTRIBUTING.md #64

Closed cannawen closed 6 years ago

cannawen commented 6 years ago

metric_units is a sassy reddit bot that finds imperial units, and replies with a metric conversion.

Current behaviour: The README and CONTRIBUTING pages are very long. This makes it hard to find what you want

Enhancement request: This chore is to research and add a solution for automatically-generated table of contents for markdown. Consider doctoc, but open to other suggestions!

Recommended reading: CONTRIBUTING.md (sections "Etiquette", "Work on an issue" and "Make a PR" are most important ... see how hard it was to find those sections!?)

Recommended skills: Basic Markdown

Estimated effort: 30-60 minutes

cpa5399 commented 6 years ago

Starter PR for this issue: https://github.com/cannawen/metric_units_reddit_bot/pull/66 I included a couple checklist items that I need to make sure are done, but would something like this solve this issue?

cannawen commented 6 years ago

Assigning issue to @cpa5399

These are my thoughts on the matter: screen shot 2017-10-06 at 8 05 47 pm

Is it possible to change the style of the header? I think it would look better as an h1-weight "Table of Contents" and then we can add the "generated with doctoc" somewhere near the bottom of the table of contents (or, remove the link entirely, we can have an "open source projects used" page somewhere else)

The table of contents itself looks perfect, exactly what I envisioned!

cpa5399 commented 6 years ago

@cannawen Totally agree! Shouldn't be too hard, I would imagine doctoc would be flexible :D

cannawen commented 6 years ago

Closing due to inactivity - Perhaps a future enhancement to look into.