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

Feature request: ability to set a custom prefix for the menu URLs #166

Open
simonw opened this issue Dec 4, 2020 · 0 comments
Open

Feature request: ability to set a custom prefix for the menu URLs #166

simonw opened this issue Dec 4, 2020 · 0 comments

Comments

@simonw
Copy link

simonw commented Dec 4, 2020

I'm using this tool for my README here: https://github.com/simonw/datasette-graphql/blob/main/README.md

That's for a Python tool that is published to PyPI, and the README on PyPI is rendered on this page: https://pypi.org/project/datasette-graphql/

Unfortunately, the links on that page don't work - because PyPI's Markdown renderer strips out the #fragment ID references from the page.

I'd love to be able to run markdown-toc like this:

markdown-toc README.md -i --url-prefix='https://github.com/simonw/datasette-graphql/blob/main/README.md'

This could generate a table of contents that looks like this:

- [Installation](https://github.com/simonw/datasette-graphql/blob/main/README.md#installation)
- [Usage](https://github.com/simonw/datasette-graphql/blob/main/README.md#usage)
...

This would mean that links on the currently broken https://pypi.org/project/datasette-graphql/ page would instead take the user to the right spot in the README hosted on GitHub.

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

No branches or pull requests

1 participant