Skip to content

docs: Give focus to toc config options #293

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.

Sign up for GitHub

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

Jump to bottom
Merged
AndrewSouthpaw merged 6 commits into from
Dec 10, 2025
Merged

docs: Give focus to toc config options #293

AndrewSouthpaw merged 6 commits into from
Dec 10, 2025
+55 −24

Conversation

@thompson-tomo
Copy link
Contributor

@thompson-tomo thompson-tomo commented Dec 6, 2025 •
edited
Loading

This improves the readme to give increased focus on toc config options vs use cases.

This also defines a npm command which updates the project readme.

Closes #149
Closes #154

@thompson-tomo thompson-tomo mentioned this pull request Dec 6, 2025
Merged
@thompson-tomo thompson-tomo changed the title Give focus to toc config options docs: Give focus to toc config options Dec 6, 2025
AndrewSouthpaw pushed a commit that referenced this pull request Dec 8, 2025
@thompson-tomo
fix: Add in checks for line breaks around skip tag #291 (#292)
dfa656b 
Closes #291

This improves the robustness of the skip tag so that it is ensured that only the intended files are being skipped.

This ensures that the project readme toc is kept upto date.

This issue was introduced with #143 and observed when working on #293
@thompson-tomo thompson-tomo marked this pull request as ready for review December 8, 2025 00:48
@thompson-tomo
Copy link
Contributor Author

thompson-tomo commented Dec 10, 2025

@PeterDaveHello / @AndrewSouthpaw i have made an attempt to make the readme flow a bit better by introducing the configuring toc options section.

AndrewSouthpaw
AndrewSouthpaw approved these changes Dec 10, 2025
View reviewed changes
Copy link
Collaborator

@AndrewSouthpaw AndrewSouthpaw left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

README.md

npm install -g doctoc

## Configuring Table of content
Copy link
Collaborator

@AndrewSouthpaw AndrewSouthpaw Dec 10, 2025

Choose a reason for hiding this comment

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

nit "Table of Contents" or "table of contents"

README.md
- no limit is placed on Markdown-formatted headings,
- whereas headings from embedded HTML are limited to 4 levels.

### Include all Headings
Copy link
Collaborator

@AndrewSouthpaw AndrewSouthpaw Dec 10, 2025

Choose a reason for hiding this comment

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

nit weird capitalization, "headings"

@AndrewSouthpaw AndrewSouthpaw merged commit e2f423d into thlorenz:master Dec 10, 2025
5 checks passed
@AndrewSouthpaw
Copy link
Collaborator

AndrewSouthpaw commented Dec 10, 2025

Ah derp I meant for you to make those minor changes before I merged, and then immediately forgot. 🤦🏼 Mind opening a separate PR? 🙏🏼

@thompson-tomo
Copy link
Contributor Author

thompson-tomo commented Dec 10, 2025

Done via #299

@thompson-tomo thompson-tomo deleted the chore/ReadmeDocs branch December 10, 2025 16:31
@thompson-tomo thompson-tomo mentioned this pull request Dec 10, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AndrewSouthpaw AndrewSouthpaw AndrewSouthpaw approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature request, help wanted] Filter out docs that already have ToCs

2 participants

@thompson-tomo @AndrewSouthpaw