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

gh-md-toc broken? #3

Closed
icct-galvarez opened this issue May 10, 2024 · 4 comments
Closed

gh-md-toc broken? #3

icct-galvarez opened this issue May 10, 2024 · 4 comments
Labels
bug Something isn't working

Comments

@icct-galvarez
Copy link
Collaborator

Realized today that the v2.4 documentation (4a7bad0) doesn't have a table of contents . I re-ran bash copy_doc.sh and it runs fine, but just doesn't add a ToC as expected. I thought that maybe it was because I changed the image on the title page (finally removing the grey background), but I was able to reproduce the issue with an old version of the word doc (at v2.3) which had previously worked.

So it appears that something has broken with the ToC generator. And looking at their GH repo, it looks like we are not the only one having this problem: ekalinin/github-markdown-toc#146.

Need to investigate further and see if there is a change I can make locally, or if the package is currently unusuable. For now, I manually added the ToC to v2.4 (476367d).

@icct-galvarez icct-galvarez added the bug Something isn't working label May 10, 2024
@icct-galvarez icct-galvarez changed the title gh-toc-md broken gh-md-toc broken? May 10, 2024
@icct-galvarez
Copy link
Collaborator Author

Discussed with Arijit and he agreed it is worth spending a few hours to dig around and see if we can get this working, since manually keeping the ToC up to date across all the different documentation pages is not ideal.

@icct-galvarez
Copy link
Collaborator Author

Still broken when I published the v2.5 docs today, but don't have time to investigate right now.

@icct-galvarez
Copy link
Collaborator Author

Resolved in v0.10.0. Just re-install the latest version:

curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
chmod a+x gh-md-toc

@icct-galvarez
Copy link
Collaborator Author

Noticed that gh-md-toc was being manually tracked in the repo (added in 47e7c7e). Not good practice to track externally maintained dependencies in our repo, so removed it in 1b71ed8.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant