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 $ ./bin/deploy [--user] ``` -By default, the script uses the `master` branch for the source code and deploys the webpage to `gh-pages`. +uses the `master` branch for the source code and deploys the webpage to `gh-pages`. The optional flag `--user` tells it to deploy to `master` and use `source` for the source code instead. Using `master` for deployment is a convention for [user and organization pages](https://help.github.com/articles/user-organization-and-project-pages/). -**Note:** when deploying your user or organization page, make sure the `_config.yml` has `url` and `baseurl` fields as follows. +Deployment to another hosting server (non GitHub Pages):
+If you decide to not use GitHub Pages and host your page elsewhere, simply run: +```bash +$ bundle exec jekyll build ``` -url: # should be empty -baseurl: # should be empty +which will (re-)generate the static webpage in the `_site/` folder. +Then simply copy the contents of the `_site/` foder to your hosting server. + +**Note:** Make sure to correctly set the `url` and `baseurl` fields in `_config.yml` before building the webpage. If you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`. If you are deploing directly to `your-domain.com`, leave `baseurl` blank. + +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. + +Let's assume that your website's publishing source is a `publishing-source` sub-directory of a git-versioned repository cloned under `$HOME/repo/`. +For a user site this could well be something like `$HOME/+ **A:** You need to add `CNAME` file to the `master` or `source` branch of your repository. + The file should contain your custom domain name. + (Relevant issue: [130](https://github.com/alshedivat/al-folio/issues/130).) + +2. **Q:** My webpage works locally. + But after deploying, it is not displayed correctly (CSS and JS is not loaded properly). + How do I fix that?
+ **A:** Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`. + If you are deploying a personal or organization website to GitHub Pages, leave both fields blank. + If you are deploying a project page to GitHub Pages, leave `url` blank and set `baseurl: /
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`: ``` scholar: last_name: Einstein first_name: [Albert, A.] ``` +If the entry matches the last name and one form of the first names, it will be underlined. Keep meta-information about your co-authors in `_data/coauthors.yml` and Jekyll will insert links to their webpages automatically. The coauthor data format in `_data/coauthors.yml` is as follows, ``` @@ -173,7 +258,7 @@ The coauthor data format in `_data/coauthors.yml` is as follows, ``` If the entry matches one of the combinations of the last names and the first names, it will be highlighted and linked to the url provided. -
- **A:** GitHub Pages rendering does not support certain Jekyll plugins, and `jekyll-scholar` that we use to render bibliography is one of them. Please make sure you deploy your website to GitHub using `bin/deploy` script that circumvents the issue. - -2. **Q:** When I deploy my fork of al-folio, it says `Deployed successfully!` - But when I open `
- **A:** For personal webpages, please run `bin/deploy --user`. - (See also relevant past issues: [#5](https://github.com/alshedivat/al-folio/issues/5), [#49](https://github.com/alshedivat/al-folio/issues/49), [#86](https://github.com/alshedivat/al-folio/issues/86).) - - ## License The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/_config.yml b/_config.yml index 06dfa24..7e5e8a1 100644 --- a/_config.yml +++ b/_config.yml @@ -113,7 +113,15 @@ kramdown: # Includes & excludes include: ['_pages'] -exclude: [vendor] +exclude: + - bin + - Gemfile + - Gemfile.lock + - vendor +keep_files: + - CNAME + - .nojekyll + - .git # Plug-ins plugins: @@ -123,8 +131,6 @@ plugins: - jekyll/scholar - jekyll-twitter-plugin - jemoji - # - bootstrap - # - material-sass # ----------------------------------------------------------------------------- # Jekyll Scholar