Jekyll-Scholar ============== Jekyll-Scholar is for all the academic bloggers out there. It is a set of extensions to [Jekyll](, the awesome, blog aware, static site generator; it formats your bibliographies and reading lists for the web and gives your blog posts citation super-powers. Installation ------------ $ [sudo] gem install jekyll-scholar Usage ----- Install and setup a new [Jekyll]( directory (see the [Jekyll-Wiki]( for detailed instructions). To enable the Jekyll-Scholar add the following statement to a file in your plugin directory (e.g., to `_plugins/ext.rb`): require 'jekyll/scholar' In your configuration you can now adjust the Jekyll-Scholar settings. The default configuration is as follows: scholar: style: apa locale: en sort_by: none order: ascending source: ./_bibliography bibliography: references.bib details_dir ./bibliography details_layout bibtex.html You can use any style that ships with [CiteProc-Ruby]( by name (e.g., apa, mla, chicago-fullnote-bibliography), or else you can add a link to any CSL style (e.g., you could link to any of the styles available at the official [CSL style repository]( The `locale` settings defines what language to use when formatting your references (this typically applies to localized terms, e.g., 'Eds.' for editors in English). The `source` option indicates where your bibliographies are stored; `bibliography` is the name of your default bibliography. ### Bibliographies Once you have loaded Jekyll-Scholar, all files with the extension `.bib` or `.bibtex` will be converted when you run Jekyll (don't forget to add a YAML header to the files); the file can contain regular HTML or Markdown and BibTeX entries; the latter will be formatted by Jekyll-Scholar according to the citation style and language defined in your configuration file. For example, if you had a file `bibliography.bib` in your root directory: --- --- References ========== @book{ruby, title = {The Ruby Programming Language}, author = {Flanagan, David and Matsumoto, Yukihiro}, year = {2008}, publisher = {O'Reilly Media} } It would be converted to `bibliography.html` with the following content:


Flanagan, D., & Matsumoto, Y. (2008). The Ruby Programming Language. O’Reilly Media.

This makes it very easy for you to add your bibliography to your Jekyll-powered blog or website. If your using other converters to generate your site, don't worry, you can still generate bibliographies using the `bibliography` tag. In your site or blog post, simply call: {% bibliography %} This will generate your default bibliography; if you use multiple, you can also pass in a name to tell Jekyll-Scholar which bibliography it should render. Let's say you have two bibliographies stored in `_bibliography/books.bib` and `_bibliography/papers.bib`; you can include the bibliographies on your site by respectively calling `{% bibliography books %}` and `{% bibliography papers %}`. For example, you could have a file `` with several reference lists: --- title: My References --- {{ page.title }} ================ The default Bibliography ------------------------ {% bibliography %} Secondary References -------------------- {% bibliography secondary %} ### Citations If you want to reference books or papers from your bibliography in your blog posts, Jekyll-Scholar can help you, too. Simply use the `cite` tag with the appropriate key of the item you want to cite and Jekyll-Scholar will create a formatted citation reference for you. For a quick example, take following blog post: --- layout: default title: A Blogging Scholar --- {{ page.title }} ================ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis 'aute irure dolor in reprehenderit in voluptate' {% cite derrida:purveyor %} velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, 'sunt in culpa qui officia deserunt mollit anim id est laborum' {% cite rabinowitz %}. Duis 'aute irure dolor in reprehenderit in voluptate' {% cite breton:surrealism %} velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, 'sunt in culpa qui officia deserunt mollit anim id est laborum' {% cite rainey %}. References ---------- {% bibliography %} ### Detail Pages If your layouts directory contains a layout file for bibliography details (the 'details_layout' configuration options), Jekyll-Scholar will generate a details page for each entry in you main bibliography. That is to say, if your bibliography contains the following entry: @book{ruby, title = {The Ruby Programming Language}, author = {Flanagan, David and Matsumoto, Yukihiro}, year = {2008}, publisher = {O'Reilly Media} } Then a page 'bibliography/ruby.html' will be generated according to your details page layout. In the layout file, you have access to all fields of your BibTeX entry. Here is an example of a details page layout: --- ---

{{ page.entry.title }}

{{ }}

{{ page.entry.abstract }}

Contributing ------------ The Jekyll-Scholar source code is [hosted on GitHub]( You can check out a copy of the latest code using Git: $ git clone If you've found a bug or have a question, please open an issue on the [Jekyll-Scholar issue tracker]( Or, for extra credit, clone the Jekyll-Scholar repository, write a failing example, fix the bug and submit a pull request. License ------- Jekyll-Scholar is distributed under the same license as Jekyll. Copyright (c) 2011-2012 [Sylvester Keil]( 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 the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.