From 52fcd07cf13e665e6d6c3849f5c42ca852497d31 Mon Sep 17 00:00:00 2001 From: Maruan Date: Sun, 3 Oct 2021 21:44:24 -0400 Subject: [PATCH] Update README.md --- README.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 128eeb3..c625938 100644 --- a/README.md +++ b/README.md @@ -111,31 +111,35 @@ $ bundle exec jekyll serve ``` Now, feel free to customize the theme however you like (don't forget to change the name!). - -**Important:** -- Make sure to change `url` field in `_config.yml` to `.github.io`. -- After you are done, **commit** your final changes. +After you are done, **commit** your final changes. #### Deployment Deploying your website to [GitHub Pages](https://pages.github.com/) is the most popular option. 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: +See below how to set it up. -**For project pages (default):** +**For personal and organization webpages:** +- Rename your repository to `.github.io` or `.github.io`. +- In `_config.yml`, set `url` to `https://.github.io` and leave `baseurl` empty in `_config.yml`. +- Make any other changes to your webpage, commit, and push! +- Either set up automatic deployment (see below) or manually deploy your webpage (also see below). +- After deployment, the webpage will become available at `.github.io`. +**For project pages:** +- In `_config.yml`, set `url` to `https://.github.io` and `baseurl` to `//`. - Make changes, commit, and push! +- Either set up automatic deployment (see below) or manually deploy your webpage (also see below). - After deployment, the webpage will become available at `.github.io//`. -- 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. -**For personal and organization webpages:** -- Rename your repository to `.github.io` or `.github.io`. -- 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. -- Make sure the `url` and `baseurl` fields in `_config.yml` are empty. +**To enable automatic deployment:** +- Click on **Actions** tab and **Enable GitHub Actions**; do not worry about creating any workflows as everything has already been set for you. - Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action. - 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. -- 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. +- 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). + -
Manual deployment to GitHub Pages: +
(click to expand) Manual deployment to GitHub Pages: If you need to manually re-deploy your website to GitHub pages, run the deploy script from the root directory of your repository: ```bash @@ -145,7 +149,7 @@ uses the `master` branch for the source code and deploys the webpage to `gh-page
-
Deployment to another hosting server (non GitHub Pages): +
(click to expand) Deployment to another hosting server (non GitHub Pages): If you decide to not use GitHub Pages and host your page elsewhere, simply run: ```bash @@ -158,7 +162,7 @@ Then simply copy the contents of the `_site/` foder to your hosting server.
-
Deployment to a separate repository (advanced users only): +
(click to expand) Deployment to a separate repository (advanced users only): **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. @@ -250,7 +254,7 @@ You can also add new `*.bib` files and customize the look of your publications h

-
Author annotation: +
(click to expand) Author annotation: In publications, the author entry for yourself is identified by string `scholar:last_name` and string array `scholar:first_name` in `_config.yml`: ```