Merge pull request #34 from timlrx/plugin/cff

Add support for multiple bibliography files

README.md

@@ -97,11 +97,11 @@ If no `bibliography` file is passed, the plugin will be skipped.
 
 #### options.bibliography
 
-Type: `string`.
+Type: `string|string[]`.
 
 By default, if no `bibliography` file is passed, the plugin will be skipped.
 
-Name of bibtex or CSL-JSON file.
+Name or path to Bibtex, CSL-JSON or CFF file. If multiple files are provided, they will be merged.
 
 #### options.path
 

demo/app/App.jsx

@@ -7,6 +7,7 @@ import {
   CustomCSLExample,
   FootnotesExample,
   LinkCitationsExample,
+  CFFExample,
 } from './md-examples'
 
 const bibliography =
@@ -18,12 +19,17 @@ const acmCSL =
 const chicagofullnoteCSL =
   'https://raw.githubusercontent.com/citation-style-language/styles/master/chicago-fullnote-bibliography.csl'
 
+const cff = 'https://raw.githubusercontent.com/timlrx/rehype-citation/main/test/CITATION.cff'
+const cff2 = 'https://raw.githubusercontent.com/tensorflow/tensorflow/master/CITATION.cff'
+const cff3 = 'https://raw.githubusercontent.com/langchain-ai/langchain/master/CITATION.cff'
+
 const examples = [
   'Default',
   'Suppress Bibliography',
   'Custom CSL',
   'Footnote Style',
   'Link Citations',
+  'Citation File Format',
 ]
 const pathList = examples.map((e) => e.toLocaleLowerCase().replace(' ', '-'))
 
@@ -56,7 +62,10 @@ function App() {
           ))}
         </div>
         {selected === examples[0] && (
-          <Example markdown={defaultExample} rehypeCitationOptions={{ bibliography }} />
+          <Example
+            markdown={defaultExample}
+            rehypeCitationOptions={{ bibliography: [bibliography, cff] }}
+          />
         )}
         {selected === examples[1] && (
           <Example
@@ -91,6 +100,14 @@ function App() {
             }}
           />
         )}
+        {selected === examples[5] && (
+          <Example
+            markdown={CFFExample}
+            rehypeCitationOptions={{
+              bibliography: [cff, cff2, cff3],
+            }}
+          />
+        )}
       </div>
     </>
   )

demo/app/main.jsx

@@ -1,10 +1,9 @@
 import React from 'react'
-import ReactDOM from 'react-dom'
+import ReactDOM from 'react-dom/client'
 import App from './App'
 
-ReactDOM.render(
+ReactDOM.createRoot(document.getElementById('root')).render(
   <React.StrictMode>
     <App />
-  </React.StrictMode>,
-  document.getElementById('root')
+  </React.StrictMode>
 )

demo/app/md-examples.js

@@ -5,9 +5,12 @@ documents and insert bibliography in html format.
 
 - Supports standard citations [@Nash1950{pp. iv, vi-xi, (xv)-(xvii)}];
 - in-text citations, @Nash1951 [p. 33] says blah;
-- and multiple citations [see @Nash1950 pp 12-13; @Nash1951]
+- multiple citations [see @Nash1950 pp 12-13; @Nash1951];
+- multiple sources [@10.5281/zenodo.1234]
 
-Customizable CSL and locale.
+Customizable CSL and locale. Bibtex, BibJSON, and CFF files are supported.
+
+\`options.biliography\` can either be a string or an array with multiple sources.
 
 ### Bibliography
 `
@@ -74,3 +77,20 @@ Implementation might differ from Pandoc, but if you run into any problems please
 
 ### Bibliography
 `
+
+export const CFFExample = `## Welcome
+
+Supports CFF files as bibliography sources - 
+easily cite sources by their CITATION.cff file.
+
+- Citation from Github cff file e.g. @10.5281/zenodo.1234 with DOI as key; 
+- Tensorflow citation [@10.5281/zenodo.4724125];
+- Langchain citation with URL as key [@github.com/langchain-ai/langchain]
+
+If a DOI is included, it will be used as the citation key.
+Otherwise the URL will be used.
+
+To cite, use the DOI reference directly or use the URL without the protocol (https://).
+
+### Bibliography
+`