- 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 addCNAME
file to themaster
orsource
branch of your repository. The file should contain your custom domain name. (Relevant issue: 130.)
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/publications.md
.
(click to expand) 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,
"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_Bach
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 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 link
You can implement your own buttons by editing the bib.html file.
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/projects.md
.
al-folio comes with stylish layouts for pages and blog posts.
The theme allows you to create blog posts in the distill.pub style:
For more details on how to create distill-styled posts using <d-*>
tags, please refer to the example.
al-folio supports fast math typesetting through KaTeX and code syntax highlighting using GitHub style:
Photo formatting is made simple using Bootstrap's grid system. Easily create beautiful grids within your blog posts and project pages:
Six beautiful theme colors have been selected to choose from.
The default is purple, but you can quickly change it by editing $theme-color
variable in the _sass/_themes.scss
file.
Other color variables are listed there as well.
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.
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 yourusername.github.io/feed.xml
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.
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.