@supremum/remark-bibtex

    0.2.7 • Public • Published

    Custom Changes

    • Use [@Wasserman1994] notation instead of (@Wasserman1994)
    • Use citation key as footnote identifier
    • Add (Wasserman & Faust, 1994)[^Wasserman1994] instead of just [^1] (in case of numeric references being used/created elsewhere)
    • Use Harvard bibliography format

    remark-bibtex

    Remark-bibtex is a remark plugin to generate footnoted citations from a bibtex file. It uses citation-js to load a specified .bib file from which citations will be retrieved and added to the markdown file's footnotes section.

    Citation keys take the form of (@citationKey): where "citationKey" corresponds to a bibtex entry in the provided .bib file. The citation key will be replaced with a numbered footnote reference corresponding to the bibliography entry in footnotes section.

    In order to work, this package has to be chained to the remark-footnotes package, which adds the necessary markdown footnoting capability.

    # My Document
    
    So here is my citation (@Wasserman1994). End of story.

    Will become:

    So here is my citation[^1]. End of story.
    
    [^1]: 1\. Wasserman S, Faust K. Social Network Analysis. Cambridge: Cambridge University Press; 1994.

    Install

    yarn add remark-footnotes @benchmark-urbanism/remark-bibtex

    Usage

    const remark = require('remark')
    const footnotes = require('remark-footnotes')
    const remarkBibtex = require('@benchmark-urbanism/remark-bibtex')
    
    const bibtexFilePath = './example/example.bib'
    
    remark()
      .use(footnotes)
      .use(remarkBibtex, { bibtexFile: bibtexFilePath })
      .process('Ref A: (@Harris2020) Ref B: (@Wasserman1994)')
      .then((content) => content.toString())
      .then((markdown) => console.log(markdown))
      .catch((err) => console.error(err))

    Will give:

    Ref A:[^1] Ref B:[^2]
    
    [^1]: 1\. Harris CR, Millman KJ, van der Walt SJ, Gommers R, Virtanen P, Cournapeau D, et al. Array programming with NumPy. Nature \[Internet]. 2020 Sep;585(7825):357–62. Available from: http://www.nature.com/articles/s41586-020-2649-2
    [^2]: 2\. Wasserman S, Faust K. Social Network Analysis. Cambridge: Cambridge University Press; 1994.

    Options

    options.bibtexFile

    A mandatory filepath to the .bib file to be loaded by citation-js

    License

    MIT © Gareth Simons

    Install

    npm i @supremum/remark-bibtex

    DownloadsWeekly Downloads

    14

    Version

    0.2.7

    License

    MIT

    Unpacked Size

    8.87 kB

    Total Files

    5

    Last publish

    Collaborators

    • supremum