Git Product home page Git Product logo

fix-markdown-footnotes's Introduction

Fix Markdown Footnotes

fmf is a CLI that will reorder foonotes chronologically.

# Before

Hello[^7] world[^3]. These[^2] are[^2b] unordered.[^hi]

# After

Hello[^1] world[^2]. These[^3] are[^4] unordered.[^5]

Try without installing

npx fix-markdown-footnotes your-file.md

Install

npm install -g fix-markdown-footnotes

Use

fmf article.md

or to fix all Markdown documents in your directory:

fmf *

If that fails, please try:

fmf '*'

Algorithm

Using the /(\[\^[^\]]*])/g regex we detect all instances of footnotes and confirm there is an even number of matches. Then we generate replacement values (via mapping to intermediate unique hashes) starting with 1 in order of appearance. Finally we write the new file contents, replacing the old file.

Developing

Run npm start to test locally. Pass in a file: npm start test.md to run the script on the file.

To install a custom version of fmf, adjust the script to your liking by editing index.js and then run npm run global. Now when you execute fmf you'll be running your version of the script.

Notes

Read the MarkdownGuide.org details about footnotes.

  • the CLI will ignore the node_modules folder
  • the CLI will not change the order of the footnotes at the bottom of the document
  • the CLI will not fix duplicate footnote numbers: having Hi[^4] lol[^4] is not proper Markdown.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.