Skip to content

I found some issues in GitHub's documentation capabilities during my internship and reported them with examples. 2/2 addressed by GitHub.

Notifications You must be signed in to change notification settings

anttiharju/github-bugreport

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

GitHub markdown problems

Can't specify the theme in which an image is shown to inside repository wiki markdowns

Status: Instead of using theme-aware images to display math formulas in both dark and light themes it's better to use MathJax: https://github.blog/changelog/2022-08-09-wikis-now-support-math-and-mermaid-diagrams/.

"Currently, theme context for images is not supported in markdown in wikis, though this is something that the team is working on fixing in the future. We would recommend keeping an eye on the GitHub Changelog for possible future announcements about this when released. https://github.blog/changelog/"

Broken example in wiki

Working example in repo

Both pages use the same markdown.

I think this feature would be important to have inside wikis to make the content look more professional. For example some mathematical notations are easiest to include with a transparent png and now the workaround is to add a background which is bound to look ugly in one of the themes.

Mermaid graph rendering breaks heading-specified links on first page load

Status: This was fixed on 11th of May 2022!

It's caused by mermaid diagrams rendering after the viewport has been moved to the heading.

You might need to disable caching via your browser's debug console.

Example. Note that the viewport should be at bottom of page. The text at the bottom of the page best illustrates the need to fix this.

About

I found some issues in GitHub's documentation capabilities during my internship and reported them with examples. 2/2 addressed by GitHub.

Topics

Resources

Stars

Watchers

Forks