Skip to content

Commit eea0e5f

Browse files
authored
Update README.md
1 parent 52fcd07 commit eea0e5f

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -117,26 +117,25 @@ After you are done, **commit** your final changes.
117117

118118
Deploying your website to [GitHub Pages](https://pages.github.com/) is the most popular option.
119119
Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0.3.5), **al-folio** will automatically re-deploy your webpage each time you push new changes to your repository! :sparkles:
120-
See below how to set it up.
121120

122121
**For personal and organization webpages:**
123-
- Rename your repository to `<your-github-username>.github.io` or `<your-github-orgname>.github.io`.
124-
- In `_config.yml`, set `url` to `https://<your-github-username>.github.io` and leave `baseurl` empty in `_config.yml`.
125-
- Make any other changes to your webpage, commit, and push!
126-
- Either set up automatic deployment (see below) or manually deploy your webpage (also see below).
127-
- After deployment, the webpage will become available at `<your-github-username>.github.io`.
122+
1. Rename your repository to `<your-github-username>.github.io` or `<your-github-orgname>.github.io`.
123+
2. In `_config.yml`, set `url` to `https://<your-github-username>.github.io` and leave `baseurl` empty.
124+
3. Set up automatic deployment of your webpage (see instructions below).
125+
4. Make changes, commit, and push!
126+
5. After deployment, the webpage will become available at `<your-github-username>.github.io`.
128127

129128
**For project pages:**
130-
- In `_config.yml`, set `url` to `https://<your-github-username>.github.io` and `baseurl` to `/<your-repository-name>/`.
131-
- Make changes, commit, and push!
132-
- Either set up automatic deployment (see below) or manually deploy your webpage (also see below).
133-
- After deployment, the webpage will become available at `<your-github-username>.github.io/<your-repository-name>/`.
129+
1. In `_config.yml`, set `url` to `https://<your-github-username>.github.io` and `baseurl` to `/<your-repository-name>/`.
130+
2. Set up automatic deployment of your webpage (see instructions below).
131+
3. Make changes, commit, and push!
132+
4. After deployment, the webpage will become available at `<your-github-username>.github.io/<your-repository-name>/`.
134133

135134
**To enable automatic deployment:**
136-
- Click on **Actions** tab and **Enable GitHub Actions**; do not worry about creating any workflows as everything has already been set for you.
137-
- Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
138-
- Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch.
139-
- Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source).
135+
1. Click on **Actions** tab and **Enable GitHub Actions**; do not worry about creating any workflows as everything has already been set for you.
136+
2. Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
137+
3. Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch.
138+
4. Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source).
140139

141140

142141
<details><summary>(click to expand) <strong>Manual deployment to GitHub Pages:</strong></summary>

0 commit comments

Comments
 (0)