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

Issue 64: Generate TOC for markdown files #66

Closed
wants to merge 1 commit into from

Conversation

cpa5399
Copy link

@cpa5399 cpa5399 commented Oct 6, 2017

Relevant to this issue: #64
Generated a table of contents for the two markdown files in this project.

Todo:

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

Copy link
Owner

@cannawen cannawen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, this looks great so far! The contributing and readme have changed, so now there are conflicts with the main repo :(

But I guess the conflicts are helpful in a way, so you can document the steps for how to auto-generate the tables ;)

@cannawen cannawen changed the title Issue 64: Generate TOC for markdown files [WIP] Issue 64: Generate TOC for markdown files Oct 8, 2017
@cannawen cannawen changed the title [WIP] Issue 64: Generate TOC for markdown files Issue 64: Generate TOC for markdown files Oct 8, 2017
@cpa5399
Copy link
Author

cpa5399 commented Oct 9, 2017

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

@nalinbhardwaj
Copy link
Collaborator

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

@cannawen
Copy link
Owner

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

@cannawen cannawen closed this Oct 30, 2017
@nalinbhardwaj
Copy link
Collaborator

@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
Copy link
Owner

@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

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.

None yet

3 participants