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.

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

Add a table of contents to the README #48

Closed
simonw opened this issue Jul 22, 2020 · 3 comments
Closed

Add a table of contents to the README #48

simonw opened this issue Jul 22, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@simonw
Copy link
Collaborator

simonw commented Jul 22, 2020

Using https://github.com/jonschlinkert/markdown-toc
@simonw simonw added the documentation Improvements or additions to documentation label Jul 22, 2020
@simonw
Copy link
Collaborator Author

simonw commented Jul 22, 2020

I'm going to use a GitHub Action to run npx markdown-toc README.md -i

simonw added a commit that referenced this issue Jul 22, 2020
@simonw
Placeholder for markdown-toc, refs #48
40d7530
simonw added a commit that referenced this issue Jul 22, 2020
@simonw
GitHub Action running markdown-toc, refs #48
e1777ab
@simonw
Copy link
Collaborator Author

simonw commented Jul 22, 2020

Done!

@simonw simonw closed this as completed Jul 22, 2020
@simonw
Copy link
Collaborator Author

simonw commented Jul 23, 2020

Frustratingly, these links don't work on PyPI: https://pypi.org/project/twitter-to-sqlite/

There's an issue about that here: pypa/readme_renderer#169

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@simonw