Skip to content

Commit 39f821b

Browse files
committed
Update README.md
1 parent 7114eaa commit 39f821b

File tree

5 files changed

+30
-20
lines changed

5 files changed

+30
-20
lines changed

README.md

+29-19
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,58 @@
11
# al-folio
2+
3+
[![demo](https://img.shields.io/badge/theme-demo-brightgreen.svg)](https://alshedivat.github.io/al-folio/)
4+
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/alshedivat/al-folio/blob/master/LICENSE)
5+
26
A simple and clean [Jekyll](https://jekyllrb.com/) theme for academics.
37

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.
8+
[![Screenshot](assets/img/full-screenshot.png)](https://alshedivat.github.io/al-folio/)
69

7-
## Features
10+
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).
11+
Since then, it got a full re-write of the styles and many additional cool features.
12+
The emphasis is on whitespace, transparency, and academic usage: [theme demo](https://alshedivat.github.io/al-folio/).
813

9-
Emphasis on whitespace, transparency, and academic usage: [theme demo](https://alshedivat.github.io/al-folio/).
14+
## Getting started
1015

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/).
16+
For more about how to use Jekyll, check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/).
17+
Why Jekyll? Read this [blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/)!
1318

14-
### Ergonomic Publications
19+
## Features
20+
21+
#### Ergonomic Publications
1522

1623
Your publications page is generated automatically from your BibTex bibliography.
1724
Simply edit `_bibliography/papers.bib`.
1825
You can also add new `*.bib` files and customize the look of your publications however you like by editing `_pages/publications.md`.
1926

2027
Keep meta-information about your co-authors in `_data/coauthors.yml` and Jekyll will insert links to their webpages automatically.
2128

22-
### Collections
29+
#### Collections
2330
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.
25-
> To do this, edit the collections in the config file, create a corresponding folder, and update the portfolio and poetry source files.
31+
The example is divided into news and projects, but easily revamp this into apps, short stories, courses, or whatever your creative work is.
32+
33+
> 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`.
2634
27-
Three different layouts are includedthe 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.
35+
Two different layouts are included: the blog layout, for a list of detailed descriptive list of entries, and the projects layout.
2836
The projects layout overlays a descriptive hoverover on a background image.
2937
If no image is provided, the square is auto-filled with the chosen theme color.
3038
Thumbnail sizing is not necessary, as the grid crops images perfectly.
3139

32-
### Theming
40+
#### Theming
3341
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.
42+
The default is purple, but quickly change it by editing `$theme-color` variable in the `_sass/variables.scss` file (line 72).
43+
Other color variables are listed there, as well.
3644

37-
### Photos
45+
#### Photos
3846
Photo formatting is made simple using rows of a 3-column system.
3947
Make photos 1/3, 2/3, or full width.
40-
Easily create beautiful grids within your blog posts and projects pages.
48+
Easily create beautiful grids within your blog posts and projects pages:
49+
50+
[![Photos](assets/img/photos-screenshot.png)](https://alshedivat.github.io/al-folio/projects/1_project/)
4151

42-
### Code Highlighting
52+
#### Code Highlighting
4353
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 %}
54+
Just use the liquid tags `{% highlight python %}` and `{% endhighlight %}` to delineate your code:
55+
[![Code](assets/img/code-screenshot.png)](https://alshedivat.github.io/al-folio/blog/2015/code/)
4656

4757
## Contributing
4858

_pages/about.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ news: true
1616
social: true
1717
---
1818

19-
Write your biography here. Tell the world about yourself. Link to your favorite [subreddit](http://reddit.com). You can put a picture in, too. The code is already in, just name your picture `prof_pic.jpg` and put it in the `img/` folder.
19+
Write your biography here. Tell the world about yourself. Link to your favorite [subreddit](http://reddit.com){:target="\_blank"}. You can put a picture in, too. The code is already in, just name your picture `prof_pic.jpg` and put it in the `img/` folder.
2020

2121
Put your address / P.O. box / other info right below your picture. You can also disable any these elements by editing `profile` property of the YAML header of your `_pages/about.md`. Edit `_bibliography/papers.bib` and Jekyll will render your [publications page](/al-folio/publications/) automatically.
2222

assets/img/code-screenshot.png

46.9 KB
Loading

assets/img/full-screenshot.png

595 KB
Loading

assets/img/photos-screenshot.png

1.78 MB
Loading

0 commit comments

Comments
 (0)