Skip to content

Commit 9aca1b3

Browse files
Update README.md
1 parent ec57b40 commit 9aca1b3

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

README.md

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,13 @@ customize your root web page and it will be served by GitHub !
128128
However, you may skip initializing your root directory.
129129

130130
### Default Documents
131-
A default document will be displayed when a visitor requests
132-
the site's URL. This is the `index.htm` file (or `index.html`
133-
to make sure other platforms will read it correctly)
131+
As was mentioned above, a default document will
132+
be displayed when a visitor requests
133+
the site's URL. This is the `index.htm` file ( or `index.html`
134+
to make sure other platforms will read it correctly )
134135
unless you change this manually for the server to give
135136
a different default document.
137+
136138
It is the same in GitHub Pages plus the `README.md`
137139
or `index.md`.
138140
So, when you create a repo for GitHub Pages,
@@ -147,44 +149,44 @@ they are still the choices for the
147149
default document. The big advantage of using pure HTML
148150
is the freedom to design your page.
149151

150-
### GitHub Directories Where It Will Be Hosting
152+
### GitHub Directories for Hosting
151153
There are three places where GitHub Pages will be building
152154
your site from: `main`, `gh-pages` or `/docs`.
153155

154156
- Using the `main`
155157
branch, there is no additional effort,
156158
just set the proper configuration in `Settings`.
157159

158-
- `gh-pages` is a branch,
159-
to create this, go to `Branch`,
160-
type in the box 'gh-pages'
161-
then click the pop-up so that
162-
it will be created.
163-
164160
- `/docs` is a subfolder of the main `branch`,
165161
just click `Create new file` then type
166-
'docs/index.htm' or any of the other
162+
`docs/index.htm` or any of the other
167163
choices for the default document.
168-
GitHub does not allow empty repository,
164+
GitHub does not allow an empty folder,
169165
so you must initialize it with a file.
170166
In this example, that is `index.htm`.
171167

172-
Furthermore, as I have observed when using just a regular
173-
account and when there is no need to change the domain name,
174-
it's just a matter of preference and technique where you
175-
will be building your site among the three options.
168+
- `gh-pages` is a branch,
169+
to create this, go to `Branch`,
170+
type in the box `gh-pages` then hit Enter.
171+
172+
So, what to use ? Here are some considerations:
173+
- if you are creating tutorial like this page of mine
174+
you are reading, simply use the `main` branch using the
175+
`README.md` file.
176+
177+
- the `/docs` folder is usual for those codebase with
178+
documentation. Other document generator also relies on
179+
this folder.
176180

177-
But there are few considerations:
178-
- First, the `main` branch can be the source when it's all
179-
about building the site.
181+
- the `gh-pages` can be your choice when your `main`
182+
branch is dedicated for your source codes and you want
183+
a dedicated hosting directory
180184

181-
- Second, the `gh-pages` can be your choice when your `main`
182-
branch is dedicated for your source codes.
185+
- the `main` branch can be the source when it's all
186+
about building the site not related to coding, as in
187+
a pure Web Page
183188

184-
- Third, the `/docs` folder is a good choice when
185-
you want to build your site from scratch where
186-
you don't copy the contents of the `main` branch,
187-
as in the case of `gh-pages` branch.
189+
Finally, it's up to the preference of the user or the team.
188190

189191
### Custom Domain
190192
Changing the default address is another story, where

0 commit comments

Comments
 (0)