You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for considering to contribute to al-folio!
3
+
4
+
5
+
## Pull Requests
6
+
We welcome your pull requests (PRs).
7
+
For minor fixes (e.g., documentation improvements), feel free to submit a PR directly.
8
+
If you would like to implement a new feature or a bug, please make sure you (or someone else) has opened an appropriate issue first; in your PR, please mention the issue it addresses.
9
+
10
+
11
+
## Issues
12
+
We use GitHub issues to track bugs and feature requests.
13
+
Before submitting an issue, please make sure:
14
+
15
+
1. You have read [the FAQ section](https://github.com/alshedivat/al-folio#faq) of the README and your question is NOT addressed there.
16
+
2. You have done your best to ensure that your issue is NOT a duplicate of one of [the previous issues](https://github.com/alshedivat/al-folio/issues).
17
+
3. Your issue is either a bug (unexpected/undesirable behavior) or a feature request.
18
+
If it is just a question, please ask it on [gitter](https://gitter.im/alshedivat/al-folio).
19
+
20
+
When submitting an issue, please make sure to use the appropriate template.
21
+
22
+
23
+
## License
24
+
By contributing to al-folio, you agree that your contributions will be licensed
25
+
under the LICENSE file in the root directory of the source tree.
Originally, **al-folio** was based on the [\*folio theme](https://github.com/bogoli/-folio) (published by [Lia Bogoev](http://liabogoev.com) and under the MIT license).
13
-
Since then, it got a full re-write of the styles and many additional cool features.
14
-
The emphasis is on whitespace, transparency, and academic usage: [theme demo](https://alshedivat.github.io/al-folio/).
15
12
16
13
## Getting started
17
14
18
15
For more about how to use Jekyll, check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/).
19
16
Why Jekyll? Read this [blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/)!
20
17
18
+
21
19
### Installation
22
20
23
-
Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), first fork the theme from `github.com:alshedivat/al-folio` to `github.com:<your-username>/<your-repo-name>` and do the following:
21
+
Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), first [fork](https://guides.github.com/activities/forking/) the theme from `github.com:alshedivat/al-folio` to `github.com:<your-username>/<your-repo-name>` and do the following:
@@ -43,80 +41,192 @@ Using `master` for deployment is a convention for [user and organization pages](
43
41
**Note:** when deploying your user or organization page, make sure the `_config.yml` has `url` and `baseurl` fields as follows.
44
42
45
43
```
46
-
url: # should be empty
44
+
url: # should be empty
47
45
baseurl: # should be empty
48
46
```
49
47
50
-
### Usage
51
48
52
-
Note that `_pages/about.md` is built to index.html in the published site. There is therefore no need to have a separate index page for the project. If an index page does exist in the root directory then this will prevent `_pages/about.md` from being added to the built site.
49
+
### Upgrading from a previous version
50
+
51
+
If you installed **al-folio** as described above, you can upgrade to the latest version as follows:
52
+
53
+
```bash
54
+
# Assuming the current directory is <your-repo-name>
If you have extensively customized a previous version, it might be trickier to upgrade.
61
+
You can still follow the steps above, but `git rebase` may result in merge conflicts that must be resolved.
62
+
See [git rebase manual](https://help.github.com/en/github/using-git/about-git-rebase) and how to [resolve conflicts](https://help.github.com/en/github/using-git/resolving-merge-conflicts-after-a-git-rebase) for more information.
63
+
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.
64
+
53
65
54
66
## Features
55
67
56
-
#### Ergonomic Publications
68
+
### Publications
57
69
58
70
Your publications page is generated automatically from your BibTex bibliography.
59
71
Simply edit `_bibliography/papers.bib`.
60
72
You can also add new `*.bib` files and customize the look of your publications however you like by editing `_pages/publications.md`.
61
73
62
74
Keep meta-information about your co-authors in `_data/coauthors.yml` and Jekyll will insert links to their webpages automatically.
63
75
64
-
#### Collections
65
-
This Jekyll theme implements collections to let you break up your work into categories.
66
-
The example is divided into news and projects, but easily revamp this into 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`.
69
78
70
-
Two different layouts are included: the blog layout, for a list of detailed descriptive list of entries, and the projects layout.
71
-
The projects layout overlays a descriptive hoverover on a background image.
72
-
If no image is provided, the square is auto-filled with the chosen theme color.
73
-
Thumbnail sizing is not necessary, as the grid crops images perfectly.
79
+
### Collections
74
80
75
-
#### Theming
76
-
Six beautiful theme colors have been selected to choose from.
77
-
The default is purple, but quickly change it by editing `$theme-color` variable in the `_sass/variables.scss` file (line 72).
78
-
Other color variables are listed there, as well.
81
+
This Jekyll theme implements `collections` to let you break up your work into categories.
82
+
The theme comes with two default collections: `news` and `projects`.
83
+
Items from the `news` collection are automatically displayed on the home page.
84
+
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.
89
+
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`.
90
+
91
+
92
+
### Layouts
93
+
94
+
**al-folio** comes with stylish layouts for pages and blog posts.
95
+
96
+
#### The iconic style of Distill
97
+
98
+
The theme allows you to create blog posts in the [distill.pub](https://distill.pub/) style:
For more details on how to create distill-styled posts using `<d-*>` tags, please refer to [the example](https://alshedivat.github.io/al-folio/blog/2018/distill/).
103
+
104
+
#### Full support for math & code
105
+
106
+
**al-folio** supports fast math typesetting through [KaTeX](https://katex.org/) and code syntax highlighting using [GitHub style](https://github.com/jwarby/jekyll-pygments-themes):
Six beautiful theme colors have been selected to choose from.
129
+
The default is purple, but you can quickly change it by editing `$theme-color` variable in the `_sass/variables.scss` file.
130
+
Other color variables are listed there as well.
100
131
101
132
#### Social media previews
102
-
The al-folio theme optionally supports preview images on social media.
103
-
To enable this functionality you will need to set `serve_og_meta` to `true` in
104
-
your `_config.yml`. Once you have done so, all your site's pages will include
105
-
Open Graph data in the HTML head element.
106
-
107
-
You will then need to configure what image to display in your site's social
108
-
media previews. This can be configured on a per-page basis, by setting the
109
-
`og_image` page variable. If for an individual page this variable is not set,
110
-
then the theme will fall back to a site-wide `og_image` variable, configurable
111
-
in your `_config.yml`. In both the page-specific and site-wide cases, the
112
-
`og_image` variable needs to hold the URL for the image you wish to display in
113
-
social media previews.
133
+
**al-folio** supports preview images on social media.
134
+
To enable this functionality you will need to set `serve_og_meta` to `true` in your `_config.yml`.
135
+
Once you have done so, all your site's pages will include Open Graph data in the HTML head element.
136
+
137
+
You will then need to configure what image to display in your site's social media previews.
138
+
This can be configured on a per-page basis, by setting the `og_image` page variable.
139
+
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`.
140
+
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.
141
+
114
142
115
143
## Contributing
116
144
117
-
Feel free to contribute new features and theme improvements by sending a pull request.
118
-
Style improvements and bug fixes are especially welcome.
145
+
Contributions to al-folio are very welcome!
146
+
Before you get started, please take a look at [the guidelines](CONTRIBUTING.md).
147
+
148
+
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`.
149
+
For more complex issues/bugs or feature requests, please open an issue using the appropriate template.
150
+
151
+
152
+
## Users of al-folio
153
+
154
+
The community of **al-folio** users is growing!
155
+
Academics around the world use this theme for their homepages, blogs, lab pages, as well as webpages for courses, workshops, conferences, meetups, and more.
156
+
Check out the community webpages below.
157
+
Feel free to add your own page(s) by sending a PR.
ML Retrospectives (<ahref="https://ml-retrospectives.github.io/neurips2019/"target="_blank">NeurIPS 2019</a>, <ahref="https://ml-retrospectives.github.io/icml2020/"target="_blank">ICML 2020</a>)
206
+
</td>
207
+
</tr>
208
+
</table>
209
+
210
+
211
+
## FAQ
212
+
213
+
Here are some frequently asked questions.
214
+
If you have a different question, please ask on [gitter](https://gitter.im/alshedivat/al-folio).
215
+
216
+
1.**Q:** When I preview my website locally everything looks great, but when I deploy it on GitHub bibliography Liquid tags are not recognized.
217
+
How do I fix this? <br>
218
+
**A:** GitHub Pages rendering does not support certain Jekyll plugins, and `jekyll-scholar` that we use to render bibliography is one of them. Please make sure you deploy your website to GitHub using `bin/deploy` script that circumvents the issue.
219
+
220
+
2.**Q:** When I deploy my fork of al-folio, it says `Deployed successfully!`
221
+
But when I open `<my-github-username>.github.io`, I get `Page not found (404)` error.
222
+
How do I fix this? <br>
223
+
**A:** For personal webpages, please run `bin/deploy --user`.
224
+
(See also relevant past issues: [#5](https://github.com/alshedivat/al-folio/issues/5), [#49](https://github.com/alshedivat/al-folio/issues/49), [#86](https://github.com/alshedivat/al-folio/issues/86).)
225
+
119
226
120
227
## License
121
228
122
229
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
230
+
231
+
Originally, **al-folio** was based on the [\*folio theme](https://github.com/bogoli/-folio) (published by [Lia Bogoev](http://liabogoev.com) and under the MIT license).
232
+
Since then, it got a full re-write of the styles and many additional cool features.
0 commit comments