docs: Fix README.md for PyPi #64
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1. Images must use absolute, raw URLs so they resolve
2. The `<a name="..."></a>` doesn't work, but [this issue](
pypa/readme_renderer#169) suggests that
`<a id="..."></a>` may work. Giving it a try.
bjchambers
commented
Feb 1, 2024
| @@ -1,12 +1,12 @@ | |||
| <!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --> | |||
| <a name="readme-top"></a> | |||
| <a id="readme-top"></a> | |||
There was a problem hiding this comment.
We may separately want to create a table of contents allowing you to jump down to sections (in addition to up).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
<a name="..."></a>doesn't work, but this issue suggests that<a id="..."></a>may work. Giving it a try.