Issue 64: Generate TOC for markdown files

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

Issue 64: Generate TOC for markdown files #66

Closed cpa5399 closed 6 years ago

cpa5399 commented 6 years ago

Relevant to this issue: https://github.com/cannawen/metric_units_reddit_bot/issues/64 Generated a table of contents for the two markdown files in this project.

Todo:

[x] - Tests pass
[ ] - Update documentation on how to use the doctoc tool whenever markdown files are changed

cpa5399 commented 6 years ago

@cannawen Awesome! I'll work on those changes soon!

nalinbhardwaj commented 6 years ago

@cpa5399 ping. Do you need any help fixing the conflicts?

cannawen commented 6 years ago

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

nalinbhardwaj commented 6 years ago

@cannawen since this is mostly done and not a lot of further work is needed here, I can finish off the work here if that's fine?

cannawen commented 6 years ago

@nalinbhardwaj We need to add some documentation on how to "refresh" the TOC when the docs get updated. You can look into it after #116 is finished if you want :) It would be a useful thing to have