pypiserver / pypiserver

Minimal PyPI server for uploading & downloading packages with pip/easy_install

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README.md TOC Links not working on github

ghinks opened this issue · comments

commented

The readme.md links in the newer markdown file are not taking the users to the correct ( or any section ) in the markdown file when viewed on the pypiserver homepage. If the README.md file is clicked upon and opened directly in viewing mode the links do work correctly.

After investigation it has been found that on the main page TOC links to header links do not work. They do work on the README.md preview.

I will raise a PR changing the headers from links to regular headings i.e.

an example of the required change is:

## [Quickstart Installation and Usage](#pypiserver)

to

## Quickstart Installation and Usage

I did test systematically but I did so in the preview page.

Oh good catch @ghinks! Thanks for noticing, TOCs and MD are always a bit tricky :) For the time being, I've checked that GH itself correctly sees the TOC:

image

So hopefully this can help to bypass the challenge for a while. But indeed thanks for noticing this again! ⭐
Do you need some help fixing this?

commented

Thank you I made the changes I thought should get get this to work in my fork and set that branch as the primary and it still did not link. So I'm scratching my head now.

Thank you I made the changes I thought should get get this to work in my fork and set that branch as the primary and it still did not link. So I'm scratching my head now.

Oh hey, no worries @ghinks, we can scratch both our heads on it 😄 If you'd like you can open a draft PR from your fork and I can think along! Interesting 🕵️

UPD: curious but it seems to work on mobile for me when I visit your fork 👍

commented

I'll open a draft PR. It could be a number of things. I have opened a draft PR 520. Of course I'll have to change my PR as mdformat has an opinion on the use of "*" rather than "-".

Awesome, thanks for opening the PR @ghinks! I will try to check it out in my free time coming week 👍