search

naokazuterada / MarkdownTOC

SublimeText3 plugin which generate a table of contents (TOC) in a markdown document.
https://packagecontrol.io/packages/MarkdownTOC
MIT License
301 stars 48 forks source link

Tips section #82

Closed jonasbn closed 7 years ago

jonasbn commented 7 years ago

Hi @naokazuterada,

I finally found some time to evaluate issue #76 so I added a Tips section to the documentation and added my own issue #81 - please merge if you find the PR suitable.

And happy new year,

jonasbn

This change is Reviewable

naokazuterada commented 7 years ago

Review status: 0 of 2 files reviewed at latest revision, 3 unresolved discussions.

README.md, line 509 at r1 (raw file):

## Tips

### How to remove the TOC

I think this title is little ambiguous. I couldn't imagine contents from this title at first. How is it to change it to How to remove anchors which added by MarkdownTOC or something like that?

README.md, line 511 at r1 (raw file):

### How to remove the TOC

If you want to remove the TOC again, you do not have to go through your complete Markdown and remove all tags manually - just follow this simple guide.

You had better mention this section. And hope to refer mutually.

README.md, line 524 at r1 (raw file):

![](./images/how_to_remove_the_toc.gif)

3. Now delete the TOC section from beginning to end and **MarkdownTOC** integration is gone

Please change this line to

<ol><li value="3">Now delete the TOC section from beginning to end and **MarkdownTOC** integration is gone</li></ol>

because the number of list is not collect. I hope README is optimized for display in HTML.

Comments from Reviewable

naokazuterada commented 7 years ago

Hi, @jonasbn

Thanks a lot for your thoughtfulness! Please consider my reviews on reviewable.

jonasbn commented 7 years ago
  1. Now delete the TOC section from beginning to end and **MarkdownTOC** integration is gone

Review status: 0 of 2 files reviewed at latest revision, 3 unresolved discussions.

README.md, line 509 at r1 (raw file):

Previously, naokazuterada (Naokazu Terada) wrote…
I think this title is little ambiguous. I couldn't imagine contents from this title at first. How is it to change it to `How to remove anchors which added by MarkdownTOC` or something like that?

I have changed it and rephrased it a bit

README.md, line 511 at r1 (raw file):

Previously, naokazuterada (Naokazu Terada) wrote…
You had better mention [this section](https://github.com/naokazuterada/MarkdownTOC#auto-anchoring-when-heading-has-anchor-defined). And hope to refer mutually.

I have made references now in both sections

README.md, line 524 at r1 (raw file):

Previously, naokazuterada (Naokazu Terada) wrote…
Please change this line to ```
  1. Now delete the TOC section from beginning to end and **MarkdownTOC** integration is gone
``` because the number of list is not collect. I hope README is optimized for display in HTML.

Tried the HTML and it looks as if it renders correctly, at least on Github

Comments from Reviewable

jonasbn commented 7 years ago

Hi @naokazuterada,

Thanks for the feedback, I have tried to accommodate your review comments, please review again.

naokazuterada commented 7 years ago

Reviewed 1 of 2 files at r1, 1 of 1 files at r2. Review status: all files reviewed at latest revision, all discussions resolved.

Comments from Reviewable

naokazuterada commented 7 years ago

@jonasbn Thank you very much! It has been merged.