GitHub Pages – Markdown Displaying as Plain Text Issue

githubgithub-pagesmarkdown

I have a GitHub repository that uses GitHub pages. However, if you visit the README page, for example, you can quickly spot that it is showing up in the plain text, not markdown.

Have I forgotten to do something? The full repository is here: https://github.com/MMK21Hub/News

Best Answer

You need to delete the README.html, as it is blocking the README.md from being converted into HTML.

Related Solutions

GitHub Markdown – Special Characters in Code Blocks

Use HTML entities style to insert special characters. For example writing

&#955;

will produce a λ

See this Wikipedia page for the complete reference.

GitHub Markdown Editor – How to Use Markdown Editor on GitHub

Indeed, Github flavoured markdown is significantly better than the MD supported here on stackexchange.

However, it is true that you don't get a toolbar to help you. It is expected that you know some basics. You can use the toolbar here to help learn some basics if you like though there is a help page linked on Github. Worth learning the github extensions.

For code, the easiest approach is to use 3 backticks on their own line, optionally followed by the code language.

In addition, you can edit things in the WIKI which does have a toolbar.

Alternatively, you can use a text editor that supports MD.

Best Answer

Related Solutions

GitHub Markdown – Special Characters in Code Blocks

GitHub Markdown Editor – How to Use Markdown Editor on GitHub

Related Topic