Skip to content

A Pelican plugin that adds an RST directive for including a BibTeX publication list

License

Notifications You must be signed in to change notification settings

dimazest/pelican_publications

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A plugin for the Pelican static website generator that embeds a BibTeX publication list in a page or article using a publications restructured text directive.

Usage

  • by passing a path to a .bib file:

    .. publications:: path/to/publications.bib
        :template: path/to/publications.html
        :sort: date
    
  • by passing BibTeX entries directly:

    .. publications::
    
        @article{hill2014simlex,
          title={Simlex-999: Evaluating semantic models with (genuine) similarity estimation},
          author={Hill, Felix and Reichart, Roi and Korhonen, Anna},
          journal={arXiv preprint arXiv:1408.3456},
          year={2014},
          url={http://arxiv.org/pdf/1408.3456v1.pdf}
        }
    

By default pelican_publications uses a publications template in the Pelican theme. This can be overridden by setting the template option as a path to a Jinja2 template. The template is passed one parameter, publications, which is a list of BibTeX entries; alternatively the BibTex entries are passed as the directive content. These BibTeX entries are simple dictionaries in the format used by the bibtexparser Python package, with a few customisations such as converting page ranges to use an html en dash and splitting the author field into a list of authors.

Possible sort options are:

date
Sort by publication date (this is the default).
key
Sort by BibTeX key.
name
Sort by author names.

About

A Pelican plugin that adds an RST directive for including a BibTeX publication list

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 97.1%
  • Makefile 2.9%