A beautiful, simple, clean, and responsive Jekyll theme for academics


Stars and forks stats for /alshedivat/al-folio

8 372 forks on 2023-06-268 378 forks on 2023-06-278 381 forks on 2023-06-288 383 forks on 2023-06-298 395 forks on 2023-06-308 398 forks on 2023-07-018 408 forks on 2023-07-028 419 forks on 2023-07-038 422 forks on 2023-07-048 428 forks on 2023-07-058 446 forks on 2023-07-068 451 forks on 2023-07-078 464 forks on 2023-07-088 472 forks on 2023-07-098 472 forks on 2023-07-108 478 forks on 2023-07-118 483 forks on 2023-07-128 492 forks on 2023-07-138 498 forks on 2023-07-148 513 forks on 2023-07-158 520 forks on 2023-07-168 520 forks on 2023-07-178 522 forks on 2023-07-188 538 forks on 2023-07-198 542 forks on 2023-07-208 551 forks on 2023-07-218 565 forks on 2023-07-228 575 forks on 2023-07-238 578 forks on 2023-07-248 582 forks on 2023-07-258 589 forks on 2023-07-268 598 forks on 2023-07-278 603 forks on 2023-07-288 617 forks on 2023-07-298 625 forks on 2023-07-308 625 forks on 2023-07-318 637 forks on 2023-08-018 646 forks on 2023-08-028 658 forks on 2023-08-038 658 forks on 2023-08-048 676 forks on 2023-08-058 685 forks on 2023-08-068 696 forks on 2023-08-078 705 forks on 2023-08-088 712 forks on 2023-08-098 717 forks on 2023-08-108 735 forks on 2023-08-118 742 forks on 2023-08-128 748 forks on 2023-08-138 753 forks on 2023-08-148 752 forks on 2023-08-158 760 forks on 2023-08-168 763 forks on 2023-08-178 764 forks on 2023-08-188 773 forks on 2023-08-198 783 forks on 2023-08-208 793 forks on 2023-08-218 804 forks on 2023-08-228 803 forks on 2023-08-238 812 forks on 2023-08-248 823 forks on 2023-08-258 824 forks on 2023-08-268 840 forks on 2023-08-278 855 forks on 2023-08-288 855 forks on 2023-08-298 872 forks on 2023-08-308 870 forks on 2023-08-318 877 forks on 2023-09-018 885 forks on 2023-09-028 893 forks on 2023-09-038 898 forks on 2023-09-048 914 forks on 2023-09-058 926 forks on 2023-09-068 930 forks on 2023-09-078 937 forks on 2023-09-088 949 forks on 2023-09-098 959 forks on 2023-09-108 964 forks on 2023-09-118 966 forks on 2023-09-128 974 forks on 2023-09-138 986 forks on 2023-09-148 993 forks on 2023-09-159 005 forks on 2023-09-169 012 forks on 2023-09-179 030 forks on 2023-09-189 031 forks on 2023-09-199 037 forks on 2023-09-209 044 forks on 2023-09-219 043 forks on 2023-09-229 054 forks on 2023-09-23

9.1kforks in total +758last 90 days

6 054 stars on 2023-06-266 060 stars on 2023-06-276 069 stars on 2023-06-286 086 stars on 2023-06-296 098 stars on 2023-06-306 103 stars on 2023-07-016 116 stars on 2023-07-026 134 stars on 2023-07-036 145 stars on 2023-07-046 151 stars on 2023-07-056 167 stars on 2023-07-066 168 stars on 2023-07-076 176 stars on 2023-07-086 178 stars on 2023-07-096 178 stars on 2023-07-106 192 stars on 2023-07-116 204 stars on 2023-07-126 215 stars on 2023-07-136 220 stars on 2023-07-146 236 stars on 2023-07-156 242 stars on 2023-07-166 250 stars on 2023-07-176 257 stars on 2023-07-186 273 stars on 2023-07-196 276 stars on 2023-07-206 284 stars on 2023-07-216 297 stars on 2023-07-226 311 stars on 2023-07-236 330 stars on 2023-07-246 338 stars on 2023-07-256 349 stars on 2023-07-266 365 stars on 2023-07-276 371 stars on 2023-07-286 379 stars on 2023-07-296 387 stars on 2023-07-306 401 stars on 2023-07-316 411 stars on 2023-08-016 420 stars on 2023-08-026 429 stars on 2023-08-036 429 stars on 2023-08-046 438 stars on 2023-08-056 446 stars on 2023-08-066 472 stars on 2023-08-076 475 stars on 2023-08-086 485 stars on 2023-08-096 489 stars on 2023-08-106 495 stars on 2023-08-116 504 stars on 2023-08-126 509 stars on 2023-08-136 529 stars on 2023-08-146 545 stars on 2023-08-156 556 stars on 2023-08-166 560 stars on 2023-08-176 566 stars on 2023-08-186 575 stars on 2023-08-196 587 stars on 2023-08-206 600 stars on 2023-08-216 608 stars on 2023-08-226 610 stars on 2023-08-236 617 stars on 2023-08-246 626 stars on 2023-08-256 631 stars on 2023-08-266 644 stars on 2023-08-276 653 stars on 2023-08-286 656 stars on 2023-08-296 664 stars on 2023-08-306 679 stars on 2023-08-316 688 stars on 2023-09-016 696 stars on 2023-09-026 701 stars on 2023-09-036 709 stars on 2023-09-046 726 stars on 2023-09-056 734 stars on 2023-09-066 738 stars on 2023-09-076 747 stars on 2023-09-086 757 stars on 2023-09-096 763 stars on 2023-09-106 768 stars on 2023-09-116 770 stars on 2023-09-126 784 stars on 2023-09-136 799 stars on 2023-09-146 809 stars on 2023-09-156 821 stars on 2023-09-166 834 stars on 2023-09-176 848 stars on 2023-09-186 854 stars on 2023-09-196 858 stars on 2023-09-206 866 stars on 2023-09-216 874 stars on 2023-09-226 879 stars on 2023-09-23

6.9kstars in total +905last 90 days

This is stars and forks stats for /alshedivat/al-folio repository. As of 23 Sep, 2023 this repository has 6879 stars and 9054 forks.

al-folio A simple, clean, and responsive Jekyll theme for academics. If you like the theme, give it a star! User community The vibrant community of al-folio users 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 ★ ★ ★ ★ ★ ★ ★ Courses CMU PGM (S-19) CMU DeepRL (F-19, S-20, F-20, S-21, F-21, S-22) CMU MMML (F-20, F-22) CMU AMMML (S-22, S-23) CMU ASI (S-23) CMU Distributed Systems (S-21) Conferences & workshops ICLR Blog Post Track (2023) ML Retrospectives (NeurIPS: 2019, 2020; ICML: 2020) HAMLETS (NeurIPS: 2020) ICBINB (NeurIPS: 2020, 2021) Neural Compression (ICLR: 2021) Score Based Methods (NeurIPS: 2022) Images2Symbols (CogSci: 2022) Medical Robotics Junior Faculty Forum (ISMR: 2023) Beyond Vision: Physics meets AI (ICIAP: 2023) Lighthouse PageSpeed Insights Table Of Contents User community Lighthouse PageSpeed Insights Table Of Contents Getting started Installation Local setup using Docker (Recommended) Local Setup (Legacy) Deployment Upgrading from a previous version FAQ Features Publications Collections Layouts The iconic style of Distill Full support for math & code Photos Other features GitHub's repositories and user stats Theming Social media previews Atom (RSS-like) Feed Related posts Contributing Maintainers License Getting started Want to learn more about Jekyll? Check out this tutorial. Why Jekyll? Read Andrej Karpathy's blog post! Installation For a hands-on walkthrough of al-folio installation, check out this cool video tutorial by one of the community members! 🎬 🍿 The preferred way of using this template is by clicking in Use this template above the file list. Then, create a new repository at<your-username>/<your-repo-name>. If you plan to upload your site to <your-github-username>, note that the name of your repository must be <your-github-username> or <your-github-orgname>, as stated in the GitHub pages docs. For more information on how to deploy your site, check the Deployment section below. After you created your new repository, just download it to your machine: $ git clone [email protected]:<your-username>/<your-repo-name>.git $ cd <your-repo-name> Local setup using Docker (Recommended) Using Docker to install Jekyll and Ruby dependencies is the easiest way. You need to take the following steps to get al-folio up and running on your local machine: First, install docker and docker-compose. Finally, run the following command that will pull the latest pre-built image from DockerHub and will run your website. $ docker-compose up Note that when you run it for the first time, it will download a docker image of size 400MB 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 (docker-compose up) to render the webpage with all you changes. Also, make sure to commit your final changes. To change port number, you can edit docker-compose.yml file. (click to expand) Build your own docker image: Note: this approach is only necessary if you would like to build an older or very custom version of al-folio. Build and run a new docker image using: $ docker-compose -f docker-local.yml up If you want to update jekyll, install new ruby packages, etc., all you have to do is build the image again using --force-recreate argument at the end of previous command! It will download ruby and jekyll and install all ruby packages again from scratch. Local Setup (Legacy) Assuming you have Ruby and Bundler installed on your system (hint: for ease of managing ruby gems, consider using rbenv), and also Python and pip (hint: for ease of managing python packages, consider using a virtual environment, like venv or conda. If you will use only jupyter, you can use pipx). $ bundle install # assuming pip is your Python package manager $ pip install jupyter $ bundle exec jekyll serve --lsi 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. Deployment 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: The name of your repository MUST BE <your-github-username> or <your-github-orgname> In _config.yml, set url to https://<your-github-username> and leave baseurl empty. 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> For project pages: In _config.yml, set url to https://<your-github-username> and baseurl to /<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><your-repository-name>/. 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. Go to Settings -> Actions -> General -> Workflow permissions, and give Read and write permissions to GitHub Actions 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 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. If you keep your site on another branch, open .github/workflows/deploy.yml on the branch you keep your website on and change on->push->branches and on->pull_request->branches to the branch you keep your website on. This will trigger the action on pulls/pushes on that branch. The action will then deploy the website on the branch it was triggered from. (click to expand) Manual deployment to GitHub Pages: If you need to manually re-deploy your website to GitHub pages, go to Actions, click "Deploy" in the left sidebar, then "Run workflow." (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: $ bundle exec jekyll build --lsi which will (re-)generate the static webpage in the _site/ folder. Then simply copy the contents of the _site/ directory 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, you must set url: and baseurl: /your-project/. If you are deploying directly to, leave baseurl blank. (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). 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 subdirectory of a git-versioned repository cloned under $HOME/repo/. For a user site this could well be something like $HOME/<user> 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): $ bundle exec jekyll build --lsi --destination $HOME/repo/publishing-source This will instruct jekyll to deploy the website under $HOME/repo/publishing-source. Note: Jekyll will clean $HOME/repo/publishing-source before building! The quote below is taken directly from the jekyll configuration docs: Destination folders are cleaned on site builds The 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-source contains files that you want jekyll to leave untouched, specify them under keep_files in _config.yml. In its default configuration, al-folio will copy the top-level to the publishing source. If you want to change this behavior, add under exclude in _config.yml. Note: Do not run jekyll clean on your publishing source repo as this will result in the entire directory getting deleted, irrespective of the content of keep_files in _config.yml. Upgrading from a previous version If you installed al-folio as described above, you can configure a GitHub action to automatically sync your repository with the latest version of the theme. Go to Settings -> Actions -> General -> Workflow permissions, give Read and write permissions to GitHub Actions, check "Allow GitHub Actions to create and approve pull requests", and save your changes. Then go to Actions -> New workflow -> set up a workflow yourself, setup the following workflow and commit your changes: name: Sync from template on: # cronjob trigger schedule: - cron: "0 0 1 * *" # manual trigger workflow_dispatch: jobs: repo-sync: runs-on: ubuntu-latest steps: # To use this repository's private action, you must check out the repository - name: Checkout uses: actions/checkout@v3 - name: actions-template-sync uses: AndreasAugustin/[email protected] with: github_token: ${{ secrets.GITHUB_TOKEN }} source_repo_path: alshedivat/al-folio upstream_branch: master You will receive a pull request within your repository if there are some changes available in the template. Another option is to manually update your code by following the steps below: # Assuming the current directory is <your-repo-name> $ git remote add upstream $ git fetch upstream $ git rebase v0.9.0 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 re-installing the new version of the theme from scratch and port over your content and changes from the previous version manually. FAQ Here are some frequently asked questions. If you have a different question, please ask using Discussions. Q: After I create a new repository from this template 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.) Q: I am using a custom domain (e.g., 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.) Q: My webpage works locally. But after deploying, it fails to build and throws Unknown tag 'toc'. How do I fix that? A: Make sure you followed through the deployment instructions in the previous section. You should have set the deployment branch to gh-pages. (Related issue: 1438.) 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> 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>/. If all previous steps were done correctly, all is missing is for your browser to fetch again the site stylesheet. 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. Q: My site doesn't work when I enable related_blog_posts. Why? A: This is probably due to the classifier reborn plugin, which is used to calculate related posts. If the error states Liquid Exception: Zero vectors can not be normalized..., it means that it could not calculate related posts for a specific post. This is usually caused by empty or minimal blog posts without meaningful words (i.e. only stop words) or even specific characters you used in your posts. Also, the calculus for similar posts are made for every post, which means every page that uses layout: post, including the announcements. To change this behavior, simply add related_posts: false to the front matter of the page you don't want to display related posts on. Features Publications Your publications' page is generated automatically from your BibTex bibliography. Simply edit _bibliography/papers.bib. You can also add new *.bib files and customize the look of your publications however you like by editing _pages/ (click to expand) Author annotation: In publications, the author entry for yourself is identified by string array scholar:last_name and string array scholar:first_name in _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.yml and Jekyll will insert links to their webpages automatically. The co-author data format in _data/coauthors.yml is as follows, "Adams": - firstname: ["Edwin", "E.", "E. P.", "Edwin Plimpton"] url: "Podolsky": - firstname: ["Boris", "B.", "B. Y.", "Boris Yakovlevich"] url: "Rosen": - firstname: ["Nathan", "N."] url: "Bach": - firstname: ["Johann Sebastian", "J. S."] url: - firstname: ["Carl Philipp Emanuel", "C. P. E."] url: 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. (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 text arxiv: 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 entry html: Inserts an "HTML" button redirecting to the user-specified link pdf: 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 link code: Adds a "Code" button redirecting to the specified link poster: 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 link altmetric: Adds an Altmetric badge (Note: if DOI is provided just use true, otherwise only add the altmetric identifier here - the link is generated automatically) dimensions: Adds a Dimensions badge (Note: if DOI or PMID is provided just use true, otherwise only add the Dimensions' identifier here - the link is generated automatically) You can implement your own buttons by editing the bib.html file. Collections This Jekyll theme implements collections to let you break up your work into categories. The theme comes with two default collections: news and projects. Items from the news collection are automatically displayed on the home page. Items from the projects collection 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.yml file, create a corresponding folder, and create a landing page for your collection, similar to _pages/ Layouts al-folio comes with stylish layouts for pages and blog posts. The iconic style of Distill The theme allows you to create blog posts in the style: For more details on how to create distill-styled posts using <d-*> tags, please refer to the example. Full support for math & code al-folio supports fast math typesetting through MathJax and code syntax highlighting using GitHub style: Photos Photo formatting is made simple using Bootstrap's grid system. Easily create beautiful grids within your blog posts and project pages: Other features GitHub's repositories and user stats al-folio uses github-readme-stats and github-profile-trophy to display GitHub repositories and user stats on the /repositories/ page. Edit the _data/repositories.yml and change the github_users and github_repos lists to include your own GitHub profile and repositories to the /repositories/ page. You may also use the following codes for displaying this in any other pages. <!-- code for GitHub users --> {% if %} <div class="repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center"> {% for user in %} {% include repository/repo_user.html username=user %} {% endfor %} </div> {% endif %} <!-- code for GitHub trophies --> {% if site.repo_trophies.enabled %} {% for user in %} {% if > 1 %} <h4>{{ user }}</h4> {% endif %} <div class="repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center"> {% include repository/repo_trophies.html username=user %} </div> {% endfor %} {% endif %} <!-- code for GitHub repositories --> {% if %} <div class="repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center"> {% for repo in %} {% include repository/repo.html repository=repo %} {% endfor %} </div> {% endif %} Theming A variety of beautiful theme colors have been selected for you to choose from. The default is purple, but you can quickly change it by editing the --global-theme-color variable in the _sass/_themes.scss file. Other color variables are listed there as well. The stock theme color options available can be found at _sass/_variables.scss. You can also add your own colors to this file assigning each a name for ease of use across the template. Social media previews al-folio supports preview images on social media. To enable this functionality you will need to set serve_og_meta to true in 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 the og_image page variable. If for an individual page this variable is not set, then the theme will fall back to a site-wide og_image variable, configurable in your _config.yml. In both the page-specific and site-wide cases, the og_image variable needs to hold the URL for the image you wish to display in social media previews. Atom (RSS-like) Feed It 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 type Related posts By default, there will be a related posts section on the bottom of the blog posts. These are generated by selecting the max_related most recent posts that share at least min_common_tags tags with the current post. If you do not want to display related posts on a specific post, simply add related_posts: false to the front matter of the post. If you want to disable it for all posts, simply set enabled to false in the related_blog_posts section in _config.yml. Contributing Contributions to al-folio are very welcome! Before you get started, please take a look at the 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 to master. For more complex issues/bugs or feature requests, please open an issue using the appropriate template. Maintainers Our most active contributors are welcome to join the maintainers team. If you are interested, please reach out! Maruan Rohan Deb Sarkar Amir Pourmand George All Contributors Made with License The theme is available as open source under the terms of the MIT License. Originally, al-folio was based on the *folio theme (published by Lia Bogoev and under the MIT license). Since then, it got a full re-write of the styles and many additional cool features.
Read on GithubGithub Stats Page