Skip to content

Commit 52fcd07

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

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

README.md

+19-15
Original file line numberDiff line numberDiff line change
@@ -111,31 +111,35 @@ $ bundle exec jekyll serve
111111
```
112112

113113
Now, feel free to customize the theme however you like (don't forget to change the name!).
114-
115-
**Important:**
116-
- Make sure to change `url` field in `_config.yml` to `<your-github-username>.github.io`.
117-
- After you are done, **commit** your final changes.
114+
After you are done, **commit** your final changes.
118115

119116
#### Deployment
120117

121118
Deploying your website to [GitHub Pages](https://pages.github.com/) is the most popular option.
122119
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.
123121

124-
**For project pages (default):**
122+
**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`.
125128

129+
**For project pages:**
130+
- In `_config.yml`, set `url` to `https://<your-github-username>.github.io` and `baseurl` to `/<your-repository-name>/`.
126131
- Make changes, commit, and push!
132+
- Either set up automatic deployment (see below) or manually deploy your webpage (also see below).
127133
- After deployment, the webpage will become available at `<your-github-username>.github.io/<your-repository-name>/`.
128-
- The `master` branch should be used for the source code of your webpage and `gh-pages` branch (will be created on the first deployment) will be used for deployment.
129134

130-
**For personal and organization webpages:**
131-
- Rename your repository to `<your-github-username>.github.io` or `<your-github-orgname>.github.io`.
132-
- Click on **Actions** tab and **Enable GitHub Actions**; you no need to worry about creating any workflows as everything has already been set for you.
133-
- Make sure the `url` and `baseurl` fields in `_config.yml` are empty.
135+
**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.
134137
- Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
135138
- 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.
136-
- Finally, in the **Settings**, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). 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) for more details.
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).
140+
137141

138-
<details><summary><strong>Manual deployment to GitHub Pages:</strong></summary>
142+
<details><summary>(click to expand) <strong>Manual deployment to GitHub Pages:</strong></summary>
139143

140144
If you need to manually re-deploy your website to GitHub pages, run the deploy script from the root directory of your repository:
141145
```bash
@@ -145,7 +149,7 @@ uses the `master` branch for the source code and deploys the webpage to `gh-page
145149

146150
</details>
147151

148-
<details><summary><strong>Deployment to another hosting server (non GitHub Pages):</strong></summary>
152+
<details><summary>(click to expand) <strong>Deployment to another hosting server (non GitHub Pages):</strong></summary>
149153

150154
If you decide to not use GitHub Pages and host your page elsewhere, simply run:
151155
```bash
@@ -158,7 +162,7 @@ Then simply copy the contents of the `_site/` foder to your hosting server.
158162

159163
</details>
160164

161-
<details><summary><strong>Deployment to a separate repository (advanced users only):</strong></summary>
165+
<details><summary>(click to expand) <strong>Deployment to a separate repository (advanced users only):</strong></summary>
162166

163167
**Note:** Do not try using this method unless you know what you are doing (make sure you are familiar with [publishing sources](https://help.github.com/en/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites)). This approach allows to have the website's source code in one repository and the deployment version in a different repository.
164168

@@ -250,7 +254,7 @@ You can also add new `*.bib` files and customize the look of your publications h
250254

251255
<p align="center"><img src="https://raw.githubusercontent.com/alshedivat/al-folio/master/assets/img/publications-screenshot.png" width=800></p>
252256

253-
<details><summary><strong>Author annotation:</strong></summary>
257+
<details><summary>(click to expand) <strong>Author annotation:</strong></summary>
254258

255259
In publications, the author entry for yourself is identified by string `scholar:last_name` and string array `scholar:first_name` in `_config.yml`:
256260
```

0 commit comments

Comments
 (0)