aneagoie / ztm-python-cheat-sheet

https://zerotomastery.io/courses/python/cheatsheet/
2.43k stars 1.35k forks source link

Links under the Contents section on website don't work #2

Closed RoyaKar closed 4 years ago

RoyaKar commented 4 years ago

Hi! The section titles (links) on the left hand side under Contents, don't seem to be working.

alexroseb commented 4 years ago

They're working for me - could you please elaborate on what's wrong?

Maximus06 commented 4 years ago

Hi It does not work for me either. In fact the left link are different from the top link (under content). Exemple for the link number on the left: https://nicedoc.io/aneagoie/ztm-python-cheat-sheet?theme=dark#user-content-numbers On the top (works fine): https://nicedoc.io/aneagoie/ztm-python-cheat-sheet?theme=dark#numbers All the left links have the term user-content- before the "key word"

PlusleNMinun commented 4 years ago

The side contents bar links also do not work for me.

aneagoie commented 4 years ago

Hey everyone! This was actually the intended behaviour: the side was meant to be just an "Outline" and the top headers the actual link to each section. If you feel like the side should also link to the sections, feel free to make a Pull Request with the changes since this cheat sheet is open sourced and can be modified/improved by anyone!

RoyaKar commented 4 years ago

Hi @aneagoie! I've made a Pull Request but unfortunately I can only view/access the ReadMe.md file and the git folder. I can't seem to access the HTML and/or the JS file to make the appropriate edits. Apologies if I've missed something as I'm pretty new to Github.

aneagoie commented 4 years ago

@RoyaKar the way it works is that nicedoc.io is a 3rd party service that reads from the README, so even for myself, the only thing that I can change is the README.

To test on your end, fork this repository, and got to your own project in nicedoc: nicedoc.io//

As you update the README there, you should see it update at the above URL.

Hope that helps :)

RoyaKar commented 4 years ago

@aneagoie It looks like the content (on the left side of the webpage) is just something that nicedoc automatically add on. I can't find it anywhere in the README file to edit.

Anyone else have any ideas on how we can add links? @alexroseb @Maximus06 @PlusleNMinun ?

aneagoie commented 4 years ago

Looking at the examples they provide this is the only one that has the left hand side navigable: https://nicedoc.io/cyrilwanner/next-optimized-image So it is doable...

alexroseb commented 4 years ago

I'm sorry, I came to this from the github repo directly, not the nicedoc site, so the links work on github. I think if it you want it just as a TOC without links that's good too but it shouldn't use elements. I'll look into how nicedoc creates that column!

aneagoie commented 4 years ago

Closing this issue, since we moved away from nicedoc and now hosting it on our own website here where the links work: https://zerotomastery.io/courses/python/cheatsheet/