Package: jiangwei-dengai
al-folioA simple, clean, and responsiveJekylltheme for academics.
If you like the theme, give it a star!User communityThe vibrant community ofal-foliousers is growing!
Academics around the world use this theme for their homepages, blogs, lab pages, as well as webpages for courses, workshops, conferences, meetups, and more.
Check out the community webpages below.
Feel free to add your own page(s) by sending a PR.Academics★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★Labs★★★★★★★CoursesCMU PGM (S-19)CMU DeepRL (F-19,S-20,F-20,S-21)CMU MMML (F-20)CMU Distributed Systems (S-21)Conferences & workshopsML Retrospectives (NeurIPS:2019,2020; ICML:2020)HAMLETS (NeurIPS:2020)ICBINB (NeurIPS:2020,2021)Neural Compression (ICLR:2021)Lighthouse PageSpeed InsightsTable Of ContentsUser communityLighthouse PageSpeed InsightsGetting startedInstallationLocal setup using Docker (Recommended on Windows)Local Setup (Standard)DeploymentUpgrading from a previous versionFAQFeaturesPublicationsCollectionsLayoutsThe iconic style of DistillFull support for math & codePhotosOther featuresGitHub repositories and user statsThemingSocial media previewsAtom (RSS-like) FeedContributingCore ContributorsLicenseGetting startedWant to learn more about Jekyll? Check outthis tutorial.
Why Jekyll? ReadAndrej Karpathy's blog post!InstallationFor a hands-on walkthrough of al-folio installation, check outthis cool video tutorialby one of the community members! 🎬 🍿Local setup using Docker (Recommended on Windows)You need to take the following steps to getal-folioup and running in your local machine:First,install dockerThen, clone this repository to your machine:$gitclonegit@github.com:<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.shNote 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.(click to expand)Build your own docker image (more advanced):Note: this approach is only necessary if you would like to build an older or very custom version of al-folio.First, download the necessary modules and install them into a docker image calledal-folio:Dockerfile(this command will build an image which is used to run your website afterwards. Note that you only need to do this step once. After you have the image, you no longer need to do this anymore):$./bin/docker_build_image.shRun the website!$./bin/docker_run.shTo change port number, you can editdocker_run.shfile.If you want to update jekyll, install new ruby packages, etc., all you have to do is build the image again usingdocker_build_image.sh! It will download ruby and jekyll and install all ruby packages again from scratch.Local Setup (Standard)Assuming you haveRubyandBundlerinstalled on your system (hint: for ease of managing ruby gems, consider usingrbenv), firstforkthe theme fromgithub.com:alshedivat/al-foliotogithub.com:<your-username>/<your-repo-name>and do the following:$gitclonegit@github.com:<your-username>/<your-repo-name>.git
$cd<your-repo-name>
$bundleinstall
$bundleexecjekyllserveNow, feel free to customize the theme however you like (don't forget to change the name!).
After you are done,commityour final changes.DeploymentDeploying your website toGitHub Pagesis the most popular option.
Starting versionv0.3.5,al-foliowill automatically re-deploy your webpage each time you push new changes to your repository! :sparkles:For personal and organization webpages:Rename your repository to<your-github-username>.github.ioor<your-github-orgname>.github.io.In_config.yml, seturltohttps://<your-github-username>.github.ioand leavebaseurlempty.Set up automatic deployment of your webpage (see instructions below).Make changes, commit, and push!After deployment, the webpage will become available at<your-github-username>.github.io.For project pages:In_config.yml, seturltohttps://<your-github-username>.github.ioandbaseurlto/<your-repository-name>/.Set up automatic deployment of your webpage (see instructions below).Make changes, commit, and push!After deployment, the webpage will become available at<your-github-username>.github.io/<your-repository-name>/.To enable automatic deployment:Click onActionstab andEnable 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 theDeployaction.Wait for a few minutes and let the action complete. You can see the progress in theActionstab. If completed successfully, in addition to themasterbranch, your repository should now have a newly builtgh-pagesbranch.Finally, in theSettingsof your repository, in the Pages section, set the branch togh-pages(NOTtomaster). For more details, seeConfiguring a publishing source for your GitHub Pages site.(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:$./bin/deployuses themasterbranch for the source code and deploys the webpage togh-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:$bundleexecjekyllbuildwhich 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 theurlandbaseurlfields in_config.ymlbefore building the webpage. If you are deploying your webpage toyour-domain.com/your-project/, you must seturl: your-domain.comandbaseurl: /your-project/. If you are deploing directly toyour-domain.com, leavebaseurlblank.(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 withpublishing sources). 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 apublishing-sourcesub-directory of a git-versioned repository cloned under$HOME/repo/.
For a user site this could well be something like$HOME/<user>.github.io.Firstly, from the deployment repo dir, checkout the git branch hosting your publishing source.Then from the website sources dir (commonly your al-folio fork's clone):$bundleexecjekyllbuild--destination$HOME/repo/publishing-sourceThis will instruct jekyll to deploy the website under$HOME/repo/publishing-source.Note:Jekyll will clean$HOME/repo/publishing-sourcebefore building!The quote below is taken directly from thejekyll configuration docs:Destination folders are cleaned on site buildsThe contents of<destination>are automatically cleaned, by default, when the site is built. Files or folders that are not created by your site will be removed. Some files could be retained by specifying them within the<keep_files>configuration directive.Do not use an important location for<destination>; instead, use it as a staging area and copy files from there to your web server.If$HOME/repo/publishing-sourcecontains files that you want jekyll to leave untouched, specify them underkeep_filesin_config.yml.
In its default configuration, al-folio will copy the top-levelREADME.mdto the publishing source. If you want to change this behaviour, addREADME.mdunderexcludein_config.yml.Note:Donotrunjekyll cleanon your publishing source repo as this will result in the entire directory getting deleted, irrespective of the content ofkeep_filesin_config.yml.Upgrading from a previous versionIf you installedal-folioas described above, you can upgrade to the latest version as follows:# Assuming the current directory is <your-repo-name>$gitremoteaddupstreamhttps://github.com/alshedivat/al-folio.git
$gitfetchupstream
$gitrebasev0.3.5If you have extensively customized a previous version, it might be trickier to upgrade.
You can still follow the steps above, butgit rebasemay result in merge conflicts that must be resolved.
Seegit rebase manualand how toresolve conflictsfor 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.FAQHere are some frequently asked questions.
If you have a different question, please ask usingDiscussions.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 releasev0.3.5or 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 followdeployment instructionsin the previous section.
(Relevant issue:209.)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 addCNAMEfile to themasterorsourcebranch of your repository.
The file should contain your custom domain name.
(Relevant issue:130.)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 theurlandbaseurlpaths in_config.yml.
Seturltohttps://<your-github-username>.github.ioor tohttps://<your.custom.domain>if you are using a custom domain.
If you are deploying a personal or organization website, leavebaseurlblank.
If you are deploying a project page, setbaseurl: /<your-project-name>/.Q:Atom feed doesn't work. Why?A:Make sure to correctly specify theurlandbaseurlpaths in_config.yml.
RSS Feed plugin works with these correctly set up fields:title,url,descriptionandauthor.
Make sure to fill them in an appropriate way and try again.FeaturesPublicationsYour publications page is generated automatically from your BibTex bibliography.
Simply edit_bibliography/papers.bib.
You can also add new*.bibfiles and customize the look of your publications however you like by editing_pages/publications.md.(click to expand)Author annotation:In publications, the author entry for yourself is identified by string arrayscholar:last_nameand string arrayscholar:first_namein_config.yml:scholar:
  last_name: [Einstein]
  first_name: [Albert, A.]If the entry matches one form of the last names and the first names, it will be underlined.
Keep meta-information about your co-authors in_data/coauthors.ymland Jekyll will insert links to their webpages automatically.
The coauthor data format in_data/coauthors.ymlis as follows,"Adams":
  - firstname: ["Edwin", "E.", "E. P.", "Edwin Plimpton"]
    url: https://en.wikipedia.org/wiki/Edwin_Plimpton_Adams

"Podolsky":
  - firstname: ["Boris", "B.", "B. Y.", "Boris Yakovlevich"]
    url: https://en.wikipedia.org/wiki/Boris_Podolsky

"Rosen":
  - firstname: ["Nathan", "N."]
    url: https://en.wikipedia.org/wiki/Nathan_Rosen

"Bach":
  - firstname: ["Johann Sebastian", "J. S."]
    url: https://en.wikipedia.org/wiki/Johann_Sebastian_Bach

  - firstname: ["Carl Philipp Emanuel", "C. P. E."]
    url: https://en.wikipedia.org/wiki/Carl_Philipp_Emanuel_BachIf 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.(click to expand)Buttons (through custom bibtex keywords):There are several custom bibtex keywords that you can use to affect how the entries are displayed on the webpage:abbr: Adds an abbreviation to the left of the entry. You can add links to these by creating a venue.yaml-file in the _data folder and adding entries that match.abstract: Adds an "Abs" button that expands a hidden text field when clicked to show the abstract textarxiv: Adds a link to the Arxiv website (Note: only add the arxiv identifier here - the link is generated automatically)bibtex_show: Adds a "Bib" button that expands a hidden text field with the full bibliography entryhtml: Inserts a "HTML" button redirecting to the user-specified linkpdf: Adds a "PDF" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)supp: Adds a "Supp" button to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)blog: Adds a "Blog" button redirecting to the specified linkcode: Adds a "Code" button redirecting to the specified linkposter: Adds a "Poster" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)slides: Adds a "Slides" button redirecting to a specified file (if a full link is not specified, the file will be assumed to be placed in the /assets/pdf/ directory)website: Adds a "Website" button redirecting to the specified linkYou can implement your own buttons by editing the bib.html file.CollectionsThis Jekyll theme implementscollectionsto let you break up your work into categories.
The theme comes with two default collections:newsandprojects.
Items from thenewscollection are automatically displayed on the home page.
Items from theprojectscollection are displayed on a responsive grid on projects page.You can easily create your own collections, apps, short stories, courses, or whatever your creative work is.
To do this, edit the collections in the_config.ymlfile, create a corresponding folder, and create a landing page for your collection, similar to_pages/projects.md.Layoutsal-foliocomes with stylish layouts for pages and blog posts.The iconic style of DistillThe theme allows you to create blog posts in thedistill.pubstyle:For more details on how to create distill-styled posts using<d-*>tags, please refer tothe example.Full support for math & codeal-foliosupports fast math typesetting throughMathJaxand code syntax highlighting usingGitHub style:PhotosPhoto formatting is made simple usingBootstrap's grid system.
Easily create beautiful grids within your blog posts and project pages:Other featuresGitHub repositories and user statsal-foliousesgithub-readme-statsto display GitHub repositories and user stats on the the/repositories/page.Edit the_data/repositories.ymland change thegithub_usersandgithub_reposlists to include your own GitHub profile and repositories to the the/repositories/page.You may also use the following codes for displaying this in any other pages.<!-- code for GitHub users -->
{% if site.data.repositories.github_users %}
<div class="repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center">
  {% for user in site.data.repositories.github_users %}
    {% include repository/repo_user.html username=user %}
  {% endfor %}
</div>
{% endif %}

<!-- code for GitHub repositories -->
{% if site.data.repositories.github_repos %}
<div class="repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center">
  {% for repo in site.data.repositories.github_repos %}
    {% include repository/repo.html repository=repo %}
  {% endfor %}
</div>
{% endif %}ThemingSix beautiful theme colors have been selected to choose from.
The default is purple, but you can quickly change it by editing$theme-colorvariable in the_sass/_themes.scssfile.
Other color variables are listed there as well.Social media previewsal-foliosupports preview images on social media.
To enable this functionality you will need to setserve_og_metatotruein your_config.yml.
Once you have done so, all your site's pages will include Open Graph data in the HTML head element.You will then need to configure what image to display in your site's social media previews.
This can be configured on a per-page basis, by setting theog_imagepage variable.
If for an individual page this variable is not set, then the theme will fall back to a site-wideog_imagevariable, configurable in your_config.yml.
In both the page-specific and site-wide cases, theog_imagevariable needs to hold the URL for the image you wish to display in social media previews.Atom (RSS-like) FeedIt generates an Atom (RSS-like) feed of your posts, useful for Atom and RSS readers.
The feed is reachable simply by typing after your homepage/feed.xml.
E.g. assuming your website mountpoint is the main folder, you can typeyourusername.github.io/feed.xmlContributingContributions to al-folio are very welcome!
Before you get started, please take a look atthe guidelines.If you would like to improve documentation, add your webpage to the list below, or fix a minor inconsistency or bug, please feel free to send a PR directly tomaster.
For more complex issues/bugs or feature requests, please open an issue using the appropriate template.Core ContributorsMaruanRohan Deb SarkarAmir PourmandLicenseThe theme is available as open source under the terms of theMIT License.Originally,al-foliowas based on the*folio theme(published byLia Bogoevand under the MIT license).
Since then, it got a full re-write of the styles and many additional cool features.