diff --git a/LICENSE b/LICENSE index a8b8461..475ecfb 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2016 Maruan Al-Shedivat. +Copyright (c) 2017 Maruan Al-Shedivat. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md index 3dc3e30..1b32d4b 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,42 @@ 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 +

+ + + +

+ +#### 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: + +

+ + + +

## Contributing diff --git a/_config.yml b/_config.yml index 99f27f6..fc3fb13 100644 --- a/_config.yml +++ b/_config.yml @@ -1,16 +1,22 @@ # ----------------------------------------------------------------------------- # Site settings # ----------------------------------------------------------------------------- - name: Your Name email: you@example.com description: > # this means to ignore newlines until "url:" A simple, whitespace theme for academics. Based on [*folio](https://github.com/bogoli/-folio) design. +footer_text: > + Powered by Jekyll with al-folio theme. + Hosted by GitHub Pages. + Photos from Unsplash. url: # the base hostname & protocol for your site baseurl: /al-folio # the subpath of your site, e.g. /blog/ +last_updated: # leave blank if you don't want to display last updated -# Social +# ----------------------------------------------------------------------------- +# Social integration +# ----------------------------------------------------------------------------- github_username: # put your github username twitter_username: # put your twitter username linkedin_username: # put your linkedin username @@ -18,17 +24,33 @@ scholar_authorid: # put your google scholar author id contact_note: > You can even add a little note about which of these is the best way to reach you. -# Footer text -footer_text: > - Powered by Jekyll with al-folio theme. - Hosted by GitHub Pages. - Photos from Unsplash. - +# ----------------------------------------------------------------------------- # Blog +# ----------------------------------------------------------------------------- blog_name: al-folio -blog_description: simple whitespace theme for academics +blog_description: a simple whitespace theme for academics +# Pagination +paginate: 4 +permalink: /blog/:year/:title/ +paginate_path: /blog/page:num/ + +text: + pagination: + newer: 'Newer' + older: 'Older' + +# Comments +disqus_shortname: al-folio # put your disqus shortname + +# Optional features +show_social_icons: false +enable_anchorjs: false +enable_katex: true + +# ----------------------------------------------------------------------------- # Collections +# ----------------------------------------------------------------------------- collections: news: defaults: @@ -38,9 +60,8 @@ collections: projects: output: true permalink: /projects/:path/ - poetry: - output: true - permalink: /poetry/:path/ + +news_limit: 5 # ----------------------------------------------------------------------------- # Jekyll settings @@ -50,11 +71,6 @@ collections: markdown: kramdown highlighter: pygments -# Pagination -paginate: 15 -permalink: /blog/:year/:title/ -paginate_path: /blog/page:num/ - # Includes include: ['_pages'] @@ -89,8 +105,8 @@ scholar: query: "@*" # ----------------------------------------------------------------------------- -# Other advanced settings (don't touch if you are not sure) +# Other settings # ----------------------------------------------------------------------------- -fontawesome_version: "4.6.3" jquery_version: "1.12.4" -katex_version: "0.6.0" +katex_version: "0.7.1" +anchorjs_version: "3.2.2" diff --git a/_includes/footer.html b/_includes/footer.html index 08b6a8f..58f34ac 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,9 +1,11 @@ -