Powered by Jekyll with al-folio theme.

.
├── 404.html # 404 page
├── assets # assets folder, for images, css, js, etc.
│   └── img # put images here
├── _config.yml # Jekyll configuration file
├── _group # group members, "成员" page
│   ├── cc.md
│   └── gongyongtang.md
├── _includes # layout components
├── _layouts # layout templates
├── _news # news, "新闻" section on the index page
│   ├── announcement_1.md
│   ├── announcement_2.md
│   └── announcement_3.md
├── _pages # pages templates
│   ├── about.md # index page, "关于我们" page
│   ├── contact.md # "招生" page
│   ├── cv.md # hidden, cv
│   ├── dropdown.md # hidden, a dropdown menu
│   ├── group.md # "成员" page. Modify members in _group folder
│   ├── projects.md # "研究项目" page. Modify projects in _projects folder
│   ├── publications.md # "发表" page. Modify publications in _publications folder
│   └── repositories.md # hidden, github repositories
├── _projects # projects, "研究项目" page
│   ├── dataset.md
│   ├── kd.md
│   └── kd-tiho.md
├── _publications # publications, "发表" page
│   ├── 2020.md
│   ├── 2021.md
│   └── 2022.md
├── README_al-folio.md # al-folio README file
├── README.md # this file
├── _sass # css
│   ├── _base.scss
│   ├── _distill.scss
│   ├── _layout.scss
│   ├── _themes.scss
│   └── _variables.scss
└── _site # generated site

Below is detailed instructions on how to setup and deploy this website from the original al-folio README file "README_al-folio.md".

Want to learn more about Jekyll? Check out this tutorial. Why Jekyll? Read Andrej Karpathy's blog post!

For a hands-on walkthrough of al-folio installation, check out this cool video tutorial by one of the community members! 🎬 🍿

You need to take the following steps to get al-folio up and running in your local machine:

• First, install docker
• Then, clone this repository to your machine:

$ git clone [email protected]:<your-username>/<your-repo-name>.git
$ cd <your-repo-name>

Finally, run the following command that will pull a pre-built image from DockerHub and will run your website.

$ ./bin/dockerhub_run.sh

Note that when you run it for the first time, it will download a docker image of size 300MB or so.

Now, feel free to customize the theme however you like (don't forget to change the name!). After you are done, you can use the same command (bin/dockerhub_run.sh) to render the webpage with all you changes. Also, make sure to commit your final changes.

$ ./bin/docker_build_image.sh  

$ ./bin/docker_run.sh

Assuming you have Ruby and Bundler installed on your system (hint: for ease of managing ruby gems, consider using rbenv), first fork the theme from github.com:alshedivat/al-folio to github.com:<your-username>/<your-repo-name> and do the following:

$ git clone [email protected]:<your-username>/<your-repo-name>.git
$ cd <your-repo-name>
$ bundle install
$ bundle exec jekyll serve

Now, feel free to customize the theme however you like (don't forget to change the name!). After you are done, commit your final changes.

Deploying your website to GitHub Pages is the most popular option. Starting version v0.3.5, al-folio will automatically re-deploy your webpage each time you push new changes to your repository! ✨

For personal and organization webpages:

1. Rename your repository to <your-github-username>.github.io or <your-github-orgname>.github.io.
2. In _config.yml, set url to https://<your-github-username>.github.io and leave baseurl empty.
3. Set up automatic deployment of your webpage (see instructions below).
4. Make changes, commit, and push!
5. After deployment, the webpage will become available at <your-github-username>.github.io.

For project pages:

1. In _config.yml, set url to https://<your-github-username>.github.io and baseurl to /<your-repository-name>/.
2. Set up automatic deployment of your webpage (see instructions below).
3. Make changes, commit, and push!
4. After deployment, the webpage will become available at <your-github-username>.github.io/<your-repository-name>/.

To enable automatic deployment:

1. Click on Actions tab and Enable GitHub Actions; do not worry about creating any workflows as everything has already been set for you.
2. Make any other changes to your webpage, commit, and push. This will automatically trigger the Deploy action.
3. 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.
4. 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.

$ ./bin/deploy

$ bundle exec jekyll build

$ bundle exec jekyll build --destination $HOME/repo/publishing-source

If you installed al-folio as described above, you can upgrade to the latest version as follows:

# Assuming the current directory is <your-repo-name>
$ git remote add upstream https://github.com/alshedivat/al-folio.git
$ git fetch upstream
$ git rebase v0.3.5

If you have extensively customized a previous version, it might be trickier to upgrade. You can still follow the steps above, but git rebase may result in merge conflicts that must be resolved. See git rebase manual and how to resolve conflicts for more information. If rebasing is too complicated, we recommend to re-install the new version of the theme from scratch and port over your content and changes from the previous version manually.

Here are some frequently asked questions. If you have a different question, please ask using Discussions.

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. Make sure to follow deployment instructions in the previous section. (Relevant issue: 209.)

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.)

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. Set url to https://<your-github-username>.github.io or to https://<your.custom.domain> if you are using a custom domain. If you are deploying a personal or organization website, leave baseurl blank. If you are deploying a project page, set baseurl: /<your-project-name>/.

4. Q: Atom feed doesn't work. Why?
   A: Make sure to correctly specify the url and baseurl paths in _config.yml. RSS Feed plugin works with these correctly set up fields: title, url, description and author. Make sure to fill them in an appropriate way and try again.