bibcite

Citations with Bibliography

latest

Source

npm

Version: 1.0.0

Version published: 4 years ago

Maintainers: 1

Created: 4 years ago

Source

Bibcite

BibTeX or BibLaTeX like citation for HTML.

Brand new and (probably) full of bugs

Browser Usage

Export your library from your favorite reference management software (e.g. Zotero) in the CSL-JSON format (Detailed Explanation).
Obtain the Javascript file of Bibcite (e.g. from JSDelivr)
Assuming you have an exported csl-json file, which we are going to call references.json from now on (but you can use any other filename). And a link to the JS file of bibcite (here called bibcite.js) you can do the following in an html file
```
<head>
  <script src="bibcite.js"></script>
  <bib-config bib="references.json"></bib-config>
</head>
<body>
  <p>
    This is an example of parenthical citation:
    <bib-cite key="id in references.json"></bib-cite>
  </p>

  <bib-references></bib-references>
</body>
```

Configuration Options

At the moment there are two citation-styles alphabetic(default) and numeric you can select them like this:
```
<bib-config bib="references.json" citation-style="numeric"></bib-config>
```
There are three types of citations inspired by BibLaTeX \textcite, \parencite and \rawcite. You can set the type of bib-cite to either paren-cite (default) text-cite or raw-cite, e.g.
```
<bib-cite key="id_key" type="text-cite"></bib-cite>
```

Node Module

You can find bibcite on npm.

Custom Styles

There will be a way to do customization in the future. Styles are Typescript types

type CiteStyle = {
  name: string;
  order: BibOrder;
  enclosing: [string, string];
  multiSeparator: string;
  identifier: (index: number, bib_data: Data, citeType: CiteType) => string;
  bib_entry: (index: number, bib_data: Data) => string;
  reference: (content: string) => string;
};

so the numeric style for example is implemented like this:

export const numeric: CiteStyle = {
  name: "numeric",
  order: { comparison: insertion, inform_citations: true },
  enclosing: ["[", "]"],
  multiSeparator: ",",
  identifier: (index: number, _: Data) => String(index),
  bib_entry: (index: number, bib_data: Data) => `
    <tr>
      <td>[${index}]</td>
      <td>
        <h3>${bib_data.title}</h3>
        <span>${bib_data.author.map((p) => p.family).join(", ")}</span>
        <span>(${bib_data.issued["date-parts"][0][0]})</span>
      </td>
    </tr>
  `,
  reference: (content: string) =>
    `<h2>References</h2>
  <table>
    ${content}
  </table>
  `,
};

I still need to figure out how to do plugin loading here though.

Keywords

FAQs

What is bibcite?

Is bibcite well maintained?

Package last updated on 01 May 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install