diff --git a/README.md b/README.md index 3dc3e30..12319c8 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,24 @@ # 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. -**al-folio** is based on [\*folio theme](https://github.com/bogoli/-folio). -The original theme was published by [Lia Bogoev](http://liabogoev.com) and copyrighted under the MIT license. +[![Screenshot](assets/img/full-screenshot.png)](https://alshedivat.github.io/al-folio/) + +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/). + +## Getting started + +For more about how to use Jekyll, check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/). +Why Jekyll? Read this [blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/)! ## Features -Emphasis on whitespace, transparency, and academic usage: [theme demo](https://alshedivat.github.io/al-folio/). - -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/). -To know *why Jekyll*, you can read this [blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/). - -### Ergonomic Publications +#### Ergonomic Publications Your publications page is generated automatically from your BibTex bibliography. Simply edit `_bibliography/papers.bib`. @@ -19,30 +26,33 @@ You can also add new `*.bib` files and customize the look of your publications h 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. -The example is divided into news, poetry, 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. +The example is divided into news and projects, but easily revamp this into apps, short stories, courses, or whatever your creative work is. -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. +> 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`. + +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. 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. -### Theming +#### Theming 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 color variable are listed there, as well. +The default is purple, but quickly change it by editing `$theme-color` variable in the `_sass/variables.scss` file (line 72). +Other color variables are listed there, as well. -### Photos +#### Photos 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. +Easily create beautiful grids within your blog posts and projects pages: -### Code Highlighting +[![Photos](assets/img/photos-screenshot.png)](https://alshedivat.github.io/al-folio/projects/1_project/) + +#### Code Highlighting This theme implements Jekyll's built in code syntax highlighting with Pygments. -Just use a liquid tag to delineate your code: -{% highlight python %} code code code {% endhighlight %} +Just use the liquid tags `{% highlight python %}` and `{% endhighlight %}` to delineate your code: +[![Code](assets/img/code-screenshot.png)](https://alshedivat.github.io/al-folio/blog/2015/code/) ## Contributing diff --git a/_pages/about.md b/_pages/about.md index e5aa936..f584b2c 100644 --- a/_pages/about.md +++ b/_pages/about.md @@ -16,7 +16,7 @@ news: 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. diff --git a/assets/img/code-screenshot.png b/assets/img/code-screenshot.png new file mode 100644 index 0000000..b2cd634 Binary files /dev/null and b/assets/img/code-screenshot.png differ diff --git a/assets/img/full-screenshot.png b/assets/img/full-screenshot.png new file mode 100644 index 0000000..ce528e6 Binary files /dev/null and b/assets/img/full-screenshot.png differ diff --git a/assets/img/photos-screenshot.png b/assets/img/photos-screenshot.png new file mode 100644 index 0000000..4069990 Binary files /dev/null and b/assets/img/photos-screenshot.png differ