Skip to content

Commit bf5fa50

Browse files
Update README.md
1 parent a68fbac commit bf5fa50

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,19 @@ As you can see, it's very practical.
8282
For free accounts, GitHub does not allow you
8383
to host from a private repo.
8484

85-
3. Initialize the repo with a README.md, or create one if
86-
it doesn't exist. This file will serve as the landing page
87-
if there are no other files to be served.
85+
3. Initialize the repo with a `README.md`, or create one if it doesn't
86+
exist. This file will serve as the default landing page on GitHub.
87+
Other options include `index.html`, `index.htm` or `index.md`. The
88+
simplest method to create a web page is by using Markdown, but you
89+
also have the option to write in HTML if you prefer. But if you are
90+
writing a content, mostly you will use Markdown more than HTML.
91+
92+
Note: While you can technically have `README.md`, `index.html`,
93+
`index.htm` and `index.md` in your repository, it's not standard
94+
practice to include all four. GitHub Pages will prioritize them in
95+
the following order: `index.html`, `index.htm`, `index.md`, and then
96+
`README.md`. It's best to choose one primary file for your landing
97+
page to avoid confusion.
8898

8999
4. Go to `Settings` of the repository and look for GitHub Pages
90100
at the left side, it's just `Pages`.

0 commit comments

Comments
 (0)