Reputation: 18066
The instructions at Git Hub Pages show me how to create a Hello World website that just says "Hello World"
The instructions also say that the website can be hosted directly from my Git Hub repository.
I have created a HelloWorld.md file
How do I get it to display on my website?
I note that if I delete index.html then GitHub generates a page based on readme.md
Upvotes: 1
Views: 619
Reputation: 440
Try adding YAML front matter to your Markdown file. Your HelloWorld.md
file should look something like this:
---
layout: default
---
Hello, world!
After this, GitHub Pages should generate a page for your Markdown file.
Upvotes: 2
Reputation: 1324278
By default, GitHub pages are rendered with Jekyll, so you would need to follow (in order to support markdown)
Using Jekyll as a static site generator with GitHub Pages
See the doc and the typical Jekyll repo structure.
I don't plan to install Jekyll locally. I have managed to get index.md showing, but there is no theme, even though _config.yml has one.
In that case, use another stack site generator for rendering your html page:
I would recommend Hugo.
Upvotes: 1