|
1 | 1 | # al-folio
|
2 |
| -A simple and clean theme for academics. Based on [\*folio](http://liabogoev.com/-folio). |
| 2 | +A simple and clean [Jekyll](https://jekyllrb.com/) theme for academics. |
3 | 3 |
|
4 |
| -## Academic Features |
| 4 | +**al-folio** is based on [\*folio theme](https://github.com/bogoli/-folio). |
| 5 | +The original theme was published by [Lia Bogoev](http://liabogoev.com) and copyrighted under the MIT license. |
5 | 6 |
|
6 |
| -TODO: add description |
| 7 | +## Features |
| 8 | + |
| 9 | +Emphasis on whitespace, transparency, and academic usage: [theme demo](https://alshedivat.github.io/al-folio/). |
| 10 | + |
| 11 | +To learn more on how to use Jekyll, you can refer to, e.g., [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/). |
| 12 | +To know *why Jekyll*, you can read this [blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/). |
7 | 13 |
|
8 | 14 | ### Ergonomic Publications
|
9 | 15 |
|
10 |
| -TODO: add description |
| 16 | +Your publications page is generated automatically from your BibTex bibliography. |
| 17 | +Simply edit `_bibliography/papers.bib`. |
| 18 | +You can also add new `*.bib` files and customize the look of your publications however you like by editing `_pages/publications.md`. |
11 | 19 |
|
12 |
| -## Original Features |
13 |
| -The following are features inherited from [\*folio](http://liabogoev.com/-folio). |
| 20 | +Keep meta-information about your co-authors in `_data/coauthors.yml` and Jekyll will insert links to their webpages automatically. |
14 | 21 |
|
15 | 22 | ### Collections
|
16 |
| -This Jekyll theme implements collections to let you break up your work into categories. The example is divided into poetry and portfolio, but easily revamp this into recipes, apps, short stories, limmericks, whatever your creative work is. |
| 23 | +This Jekyll theme implements collections to let you break up your work into categories. |
| 24 | +The example is divided into news, poetry, and projects, but easily revamp this into apps, short stories, courses, or whatever your creative work is. |
17 | 25 | > To do this, edit the collections in the config file, create a corresponding folder, and update the portfolio and poetry source files.
|
18 | 26 |
|
19 |
| -Three different layouts are included—the poetry layout, for a simple list of entries, the blog layout (index.html), for more detailed descriptive list of entries, and the portfolio layout. The portfolio layout overlays a descriptive hoverover on a background image. If no image is provided, the square is auto-filled with the chosen theme color. Thumbnail sizing is not necessary, as the grid crops images perfectly. |
20 |
| - |
21 |
| -### Portfolio Specifics |
22 |
| -You can easily add full pages for each of the projects in your portfolio. If you want one to link to an external website, create a file for it in \_portfolio, and fill in the YAML front matter as you would for another, but with a redirect, like so: |
23 |
| - |
24 |
| - --- |
25 |
| - layout: post |
26 |
| - title: Project |
27 |
| - description: a project that redirects to another website |
28 |
| - img: |
29 |
| - redirect: https://otherpage.com |
30 |
| - --- |
| 27 | +Three different layouts are included—the poetry layout, for a simple list of entries, the blog layout (`blog/index.html`), for more detailed descriptive list of entries, and the portfolio layout. |
| 28 | +The projects layout overlays a descriptive hoverover on a background image. |
| 29 | +If no image is provided, the square is auto-filled with the chosen theme color. |
| 30 | +Thumbnail sizing is not necessary, as the grid crops images perfectly. |
31 | 31 |
|
32 | 32 | ### Theming
|
33 |
| -Six beautiful theme colors have been selected to choose from. The default is red, but quickly change it by editing the \_base.scss file in line 40. The color variable are listed there, as well. |
| 33 | +Six beautiful theme colors have been selected to choose from. |
| 34 | +The default is purple, but quickly change it by editing the `_sass/base.scss` file in line 40. |
| 35 | +The color variable are listed there, as well. |
34 | 36 |
|
35 | 37 | ### Photos
|
36 |
| -Photo formatting is made simple using rows of a 3-column system. Make photos 1/3, 2/3, or full width. Easily create beautiful grids within your blog posts and projects pages. |
| 38 | +Photo formatting is made simple using rows of a 3-column system. |
| 39 | +Make photos 1/3, 2/3, or full width. |
| 40 | +Easily create beautiful grids within your blog posts and projects pages. |
37 | 41 |
|
38 | 42 | ### Code Highlighting
|
39 |
| -This theme implements Jekyll's built in code syntax highlighting with Pygments. Just use a liquid tag to delineate your code: |
| 43 | +This theme implements Jekyll's built in code syntax highlighting with Pygments. |
| 44 | +Just use a liquid tag to delineate your code: |
| 45 | +{% highlight python %} code code code {% endhighlight %} |
| 46 | + |
| 47 | +## Contributing |
| 48 | + |
| 49 | +Feel free to contribute new features and theme improvements by sending a pull request. |
| 50 | +Style improvements and bug fixes are especially welcome. |
40 | 51 |
|
41 | 52 | ## License
|
42 | 53 |
|
|
0 commit comments