npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@benrbray/rehype-cite

v2.0.1-alpha.5

Published

A `rehype` plugin for rendering citations and bibliographies.

Downloads

4

Readme

rehype-cite

The rehype-cite package is a rehype plugin adding support for inline citations and bibliographies.

For now, rehype-cite is not capable of producing citations that adhere strictly to well-known bibliography formats like APA, MLA, IEEE, etc.. You should only use rehype-cite in non-academic contexts like blog posts or note-taking.

[!IMPORTANT] If you have strict formatting requirements, consider using rehype-citation or citeproc-js instead, for compatibility with the Citation Style Language.

Installation

npm install @benrbray/rehype-cite

Usage

const bibFile = `
@book{riehl2017:category,
  title={Category theory in context},
  author={Riehl, Emily},
  year={2017},
  publisher={Courier Dover Publications},
  url={https://store.doverpublications.com/048680903x.html}
}
`;

const processor = unified()
  .use(remarkParse)
  .use(remarkMath)
  .use(remarkCite)
  .use(remarkRehype)
  .use(rehypeKatex)
  .use(rehypeCite, { bibFiles : [bibFile] })
  .use(rehypeStringify);

const markdown = "[@riehl2017:category]";
const result: string = processor.processSync(markdown).toString();

Goals

When using rehype-cite, you will quickly notice that the citations produced by rehype-cite do not adhere to any standard citation format (such as APA, MLA, Harvard, etc.).

Existing JavaScript libraries for citation rendering (such as citation-js and citeproc-js) support a great many citation styles in CSL format, but unfortunately are designed to produce only strings rather than structured output like HTML or JSON. This makes it difficult to add interactivity such as hyperlinked titles to bibliography entries.

Instead, rehype-cite includes a custom formatter which produces structured output convenient for styling, hyperlinking, and further postprocessing of bibliography data. The final citations are "good enough" for use in contexts like blog posts or personal notes, but should not be used in formal academic contexts.

Writing a Custom Formatter (experimental)

In addition to the built-in formatter, rehype-cite includes a DSL for writing new formatters.

Resources