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

remark-bibliography

v1.0.0

Published

Remark plugin for adding bibliographies to markdown.

Downloads

148

Readme

remark-bibliography

CI/CD Status MIT License stars

Remark plugin for adding citations and bibliographies to Markdown documents.

Bibliographies are included by specifying the bibliography field in the YAML frontmatter metadata at the top of each document. Inline citations simply use @ followed by the name of the source. A complete bibliography will then be appended to the bottom of the output. See the example below for more details.

This plugin requires remark-meta to resolve the path to bibliography files. Files are resolved relative to the path of the markdown file.

BibJSON is the only format currently supported, but support for other formats like BibTeX, MODS, and RIS is planned. Pull requests are welcome.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install remark-bibliography

Example

Consider the following example:

---
bibliography: example.json
locale: en-us
style: chicago
---

# Example Bibliography

Example citation:

Vulkan has better support for multithreading than OpenGL (@singh2016)

See the full reference for this citation below:

When given a bibliography file example/example.json, the result will look something like this: examples/example.html

Configuring

remark-bibliography is configured using several metadata fields in each document.

bibliography

Required. Specifies the path to the bibliography file, relative to the current file.

locale

Which locale the citations use. Supported options: de-de, en-gb, en-us, es-es, and fr-fr (default: en-us).

style

Which citation style to use for inline citations and the bibliography. Supported options: apa, chicago, mla, and vancouver (default: chicago).

Usage

import { unified } from 'unified'
import markdown from 'remark-parse'
import html from 'rehype-stringify'
import remark2rehype from 'remark-rehype'
import bibliography from 'remark-bibliography'
import frontmatter from 'remark-frontmatter'
import meta from 'remark-meta'

unified()
  .use(markdown)
  .use(frontmatter)
  .use(meta)
  .use(bibliography)
  .use(remark2rehype)
  .use(html)

License

MIT © Alex Shaw