You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+19-15
Original file line number
Diff line number
Diff line change
@@ -111,31 +111,35 @@ $ bundle exec jekyll serve
111
111
```
112
112
113
113
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.
118
115
119
116
#### Deployment
120
117
121
118
Deploying your website to [GitHub Pages](https://pages.github.com/) is the most popular option.
122
119
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.
123
121
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`.
125
128
129
+
**For project pages:**
130
+
- In `_config.yml`, set `url` to `https://<your-github-username>.github.io` and `baseurl` to `/<your-repository-name>/`.
126
131
- Make changes, commit, and push!
132
+
- Either set up automatic deployment (see below) or manually deploy your webpage (also see below).
127
133
- 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.
129
134
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.
134
137
- Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action.
135
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.
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
+
137
141
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>
139
143
140
144
If you need to manually re-deploy your website to GitHub pages, run the deploy script from the root directory of your repository:
141
145
```bash
@@ -145,7 +149,7 @@ uses the `master` branch for the source code and deploys the webpage to `gh-page
145
149
146
150
</details>
147
151
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>
149
153
150
154
If you decide to not use GitHub Pages and host your page elsewhere, simply run:
151
155
```bash
@@ -158,7 +162,7 @@ Then simply copy the contents of the `_site/` foder to your hosting server.
158
162
159
163
</details>
160
164
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>
162
166
163
167
**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.
164
168
@@ -250,7 +254,7 @@ You can also add new `*.bib` files and customize the look of your publications h
0 commit comments