Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alshedivat committed May 27, 2017
1 parent 7114eaa commit 39f821b
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 20 deletions.
48 changes: 29 additions & 19 deletions README.md
Original file line number Original file line Diff line number Diff line change
@@ -1,48 +1,58 @@
# al-folio # al-folio

[![demo](https://img.shields.io/badge/theme-demo-brightgreen.svg)](https://alshedivat.github.io/al-folio/)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/alshedivat/al-folio/blob/master/LICENSE)

A simple and clean [Jekyll](https://jekyllrb.com/) theme for academics. A simple and clean [Jekyll](https://jekyllrb.com/) theme for academics.


**al-folio** is based on [\*folio theme](https://github.com/bogoli/-folio). [![Screenshot](assets/img/full-screenshot.png)](https://alshedivat.github.io/al-folio/)
The original theme was published by [Lia Bogoev](http://liabogoev.com) and copyrighted under the MIT license.


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


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


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


### Ergonomic Publications ## Features

#### Ergonomic Publications


Your publications page is generated automatically from your BibTex bibliography. Your publications page is generated automatically from your BibTex bibliography.
Simply edit `_bibliography/papers.bib`. 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`. You can also add new `*.bib` files and customize the look of your publications however you like by editing `_pages/publications.md`.


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


### Collections #### Collections
This Jekyll theme implements collections to let you break up your work into categories. This Jekyll theme implements collections to let you break up your work into categories.
The example is divided into news, poetry, and projects, but easily revamp this into apps, short stories, courses, or whatever your creative work is. 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 file, create a corresponding folder, and update the portfolio and poetry source files.
> 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`.
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. Two different layouts are included: the blog layout, for a list of detailed descriptive list of entries, and the projects layout.
The projects layout overlays a descriptive hoverover on a background image. The projects layout overlays a descriptive hoverover on a background image.
If no image is provided, the square is auto-filled with the chosen theme color. 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. Thumbnail sizing is not necessary, as the grid crops images perfectly.


### Theming #### Theming
Six beautiful theme colors have been selected to choose from. Six beautiful theme colors have been selected to choose from.
The default is purple, but quickly change it by editing the `_sass/base.scss` file in line 40. The default is purple, but quickly change it by editing `$theme-color` variable in the `_sass/variables.scss` file (line 72).
The color variable are listed there, as well. Other color variables are listed there, as well.


### Photos #### Photos
Photo formatting is made simple using rows of a 3-column system. Photo formatting is made simple using rows of a 3-column system.
Make photos 1/3, 2/3, or full width. Make photos 1/3, 2/3, or full width.
Easily create beautiful grids within your blog posts and projects pages. Easily create beautiful grids within your blog posts and projects pages:

[![Photos](assets/img/photos-screenshot.png)](https://alshedivat.github.io/al-folio/projects/1_project/)


### Code Highlighting #### Code Highlighting
This theme implements Jekyll's built in code syntax highlighting with Pygments. This theme implements Jekyll's built in code syntax highlighting with Pygments.
Just use a liquid tag to delineate your code: Just use the liquid tags `{% highlight python %}` and `{% endhighlight %}` to delineate your code:
{% highlight python %} code code code {% endhighlight %} [![Code](assets/img/code-screenshot.png)](https://alshedivat.github.io/al-folio/blog/2015/code/)


## Contributing ## Contributing


Expand Down
2 changes: 1 addition & 1 deletion _pages/about.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ news: true
social: true social: true
--- ---


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. 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.


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. 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.


Expand Down
Binary file added assets/img/code-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/full-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/img/photos-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 39f821b

Please sign in to comment.