https://github.com/hellt/markdown-footnote-sorter

A script to sort footnotes in a markdown file
https://github.com/hellt/markdown-footnote-sorter

Last synced: 7 months ago
JSON representation

A script to sort footnotes in a markdown file

• Host: GitHub
• URL: https://github.com/hellt/markdown-footnote-sorter
• Owner: hellt
• License: apache-2.0
• Created: 2024-09-07T07:52:03.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-02T09:21:30.000Z (over 1 year ago)
• Last Synced: 2025-04-06T00:42:37.163Z (about 1 year ago)
• Language: Python
• Size: 44.9 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# markdown-footnote-sorter

A script to sort footnotes in a Markdown file.

Reads a Markdown file passed as the first argument and sorts footnotes.

The reference links will be numbered in

the order they appear in the text and placed at the bottom

of the file.

Based on 

Inspired by 

[Example video](https://github.com/user-attachments/assets/2ccb1782-1d85-499c-ba09-3be94c34a591)

## How to use?

1. You can use the container image provided:

    ```bash

    docker run --rm -v $(pwd):/work ghcr.io/hellt/markdown-footnote-sorter path/to/doc.md

    ```

1. Or download the script and put it in your `$PATH`:

    ```bash

    curl -sL \

    https://raw.githubusercontent.com/hellt/markdown-footnote-sorter/main/fnsort.py\

      > ~/.local/bin/fnsort.py

    fnsort.py path/to/doc.md

    ```

1. Or from the GitHub UI, run the container in a :sparkles:[Codespace](https://docs.github.com/en/codespaces/overview):

   1. With the click of a button

      * [![Launch in GitHub Codespaces](https://img.shields.io/badge/fnsort-Launch%20Codespace-238636?logo=github)](https://github.com/codespaces/new/hellt/markdown-footnote-sorter?devcontainer_path=.devcontainer%2Fdevcontainer.json)

   1. Manual steps

      * From this project's main page, click **Code**, then **Codespace**.

      * Choose **Create codespace on \**

         This [creates a codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository)

         with the default resources (currently 2 CPU, 8 GB RAM, 32 GB Storage).

      * :rocket: Run fnsort on your Markdown file:

         ```bash

         /app/fnsort.py path/to/doc.md

         ```

> [!IMPORTANT]

> Keep in mind there are

> [monthly limits measured in core hours](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts)

> and to [stop your codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace)

> :stop_sign: when you're not using it to conserve your monthly core hours

> allowance.

## Command Line Arguments

### --adjacent

Adjacent inline references that are not separated by other characters become

problematic (by default).

This option adds spacing between those inline references so they are properly

identified during sorting.

`fnsort.py path/to/doc.md --adjacent`

### --keepnames

Retain or keep inline reference and footnote names.

This prevents the default behavior of replacing the names with numbers.

Footnotes at the end of the Markdown are **still sorted**.

`fnsort.py path/to/doc.md --keepnames`

## Contributing

For information about contributing to this project, see the

[contributing guidelines](CONTRIBUTING.md).