hakyll-4.16.3.0: A static website compiler library
Safe HaskellSafe-Inferred
LanguageHaskell2010

Hakyll.Web.Pandoc.Biblio

Description

Wraps pandocs bibiliography handling

In order to add a bibliography, you will need a bibliography file (e.g. .bib) and a CSL file (.csl). Both need to be compiled with their respective compilers (biblioCompiler and cslCompiler). Then, you can refer to these files when you use readPandocBiblio. This function also takes the reader options for completeness -- you can use defaultHakyllReaderOptions if you're unsure. If you already read the source into a Pandoc type and need to add processing for the bibliography, you can use processPandocBiblio instead. pandocBiblioCompiler is a convenience wrapper which works like pandocCompiler, but also takes paths to compiled bibliography and csl files; pandocBibliosCompiler is similar but instead takes a glob pattern for bib files.

Synopsis

Documentation

newtype CSL Source #

Constructors

CSL 

Fields

Instances

Instances details
Show CSL Source # 
Instance details

Defined in Hakyll.Web.Pandoc.Biblio

Methods

showsPrec :: Int -> CSL -> ShowS #

show :: CSL -> String #

showList :: [CSL] -> ShowS #

Binary CSL Source # 
Instance details

Defined in Hakyll.Web.Pandoc.Biblio

Methods

put :: CSL -> Put #

get :: Get CSL #

putList :: [CSL] -> Put #

Writable CSL Source # 
Instance details

Defined in Hakyll.Web.Pandoc.Biblio

Methods

write :: FilePath -> Item CSL -> IO () Source #

newtype Biblio Source #

Constructors

Biblio 

Fields

Instances

Instances details
Show Biblio Source # 
Instance details

Defined in Hakyll.Web.Pandoc.Biblio

Binary Biblio Source # 
Instance details

Defined in Hakyll.Web.Pandoc.Biblio

Methods

put :: Biblio -> Put #

get :: Get Biblio #

putList :: [Biblio] -> Put #

Writable Biblio Source # 
Instance details

Defined in Hakyll.Web.Pandoc.Biblio

Methods

write :: FilePath -> Item Biblio -> IO () Source #

pandocBiblioCompiler :: String -> String -> Compiler (Item String) Source #

Compiles a markdown file via Pandoc. Requires the .csl and .bib files to be known to the compiler via match statements.

pandocBibliosCompiler :: String -> String -> Compiler (Item String) Source #

Compiles a markdown file via Pandoc. Requires the .csl and .bib files to be known to the compiler via match statements.