Socket
Socket
Sign inDemoInstall

remark-footnotes

Package Overview
Dependencies
Maintainers
3
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

remark-footnotes

Deprecated: this package is no longer maintained. Please use [`remark-gfm`][gfm] instead. That package match how footnotes work on github.com, which is more likely to match the expectations of authors.


Version published
Weekly downloads
1.5M
decreased by-0.79%
Maintainers
3
Weekly downloads
 
Created

What is remark-footnotes?

The remark-footnotes package is a plugin for the remark Markdown processor that allows users to add footnotes to their Markdown documents. It provides a syntax to include footnotes in the text, which are then rendered as references within the document, typically at the bottom of the page.

What are remark-footnotes's main functionalities?

Footnote Definition

This feature allows users to define footnotes in their Markdown content. The code sample shows how to use the remark-footnotes plugin with the remark library to process a Markdown string that includes a footnote definition.

const remark = require('remark');
const footnotes = require('remark-footnotes');

remark()
  .use(footnotes, { inlineNotes: true })
  .process('Some text[^1].\n\n[^1]: This is a footnote.', function (err, file) {
    console.log(String(file));
  });

Inline Footnotes

This feature enables the use of inline footnotes, which are footnotes defined directly within the text. The code sample demonstrates how to enable inline footnotes using the remark-footnotes plugin.

const remark = require('remark');
const footnotes = require('remark-footnotes');

remark()
  .use(footnotes, { inlineNotes: true })
  .process('Some text^[This is an inline footnote].', function (err, file) {
    console.log(String(file));
  });

Other packages similar to remark-footnotes

FAQs

Package last updated on 01 Oct 2024

Did you know?

Socket

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

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc