From 11ce2d2268ff4dca9c1fb7c9e8baae8ff116688d Mon Sep 17 00:00:00 2001 From: Maruan Date: Thu, 4 Mar 2021 10:19:08 -0500 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 265d9f4..3303d37 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,12 @@ [![build status](https://travis-ci.org/alshedivat/al-folio.svg?branch=master)](https://travis-ci.org/alshedivat/al-folio) [![demo](https://img.shields.io/badge/theme-demo-brightgreen.svg)](https://alshedivat.github.io/al-folio/) -[![gitter](https://badges.gitter.im/alshedivat/al-folio.svg)](https://gitter.im/alshedivat/al-folio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) +[![GitHub contributors](https://img.shields.io/github/contributors/alshedivat/al-folio.svg)](https://GitHub.com/alsheidvat/al-folio/graphs/contributors/) +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/alshedivat/al-folio) ![GitHub](https://img.shields.io/github/license/alshedivat/al-folio?color=blue) [![GitHub stars](https://img.shields.io/github/stars/alshedivat/al-folio)](https://github.com/alshedivat/al-folio) [![GitHub forks](https://img.shields.io/github/forks/alshedivat/al-folio)](https://github.com/alshedivat/al-folio/fork) +[![support](https://img.shields.io/badge/support-Ko--fi-yellow.svg)](https://ko-fi.com/alshedivat) A simple, clean, and responsive [Jekyll](https://jekyllrb.com/) theme for academics. If you like the theme, give it a star! @@ -198,16 +200,21 @@ If rebasing is too complicated, we recommend to re-install the new version of th ### FAQ Here are some frequently asked questions. -If you have a different question, please ask on [gitter](https://gitter.im/alshedivat/al-folio). +If you have a different question, please ask using [Discussions](https://github.com/alshedivat/al-folio/discussions/categories/q-a). -1. **Q:** I am using a custom domain (e.g., `foo.com`). +1. **Q:** After I fork and setup the repo, I get a deployment error. + Isn't the website supposed to correctly deploy automatically?
+ **A:** Yes, if you are using release `v0.3.5` or later, the website will automatically and correctly re-deploy right after your first commit. + Please make some changes (e.g., change your website info in `_config.yml`), commit, and push. + +2. **Q:** I am using a custom domain (e.g., `foo.com`). My custom domain becomes blank in the repository settings after each deployment. How do I fix that?
**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. +3. **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`.