Obsidian Stats logoObsidian Stats

Tidy Footnotes

by Charlie Chao
5
4
3
2
1
Score: 50/100
Install Code

Description

Category: Note Enhancements
#footnote#tidy

The Tidy Footnotes plugin! This new addition to the Obsidian family is a game-changer for anyone who likes to take notes and reference materials. With this plugin, you can easily manage your footnotes and make them appear in a neat and organized way throughout your notes. No more digging through long documents or scrolling endlessly to find the footnote you need - Tidy Footnotes makes it easy to access and reference your notes with just a click. Whether you're a student, researcher, or simply someone who likes to take organized notes, this plugin is sure to become a trusted companion in your note-taking journey.

Reviews

No reviews yet.

Stats

55
stars
22,347
downloads
2
forks
1,835
days
573
days
573
days
2
total PRs
0
open PRs
1
closed PRs
1
merged PRs
5
total issues
3
open issues
2
closed issues
15
commits

Latest Version

0.1.2
2 years ago

Changelog

  • Fixed footnote marker being identified as a definition when there is an extra square bracket before the colon
  • Ensure definition is correctly identified only when there is no leading whitespace
  • Hide command in reading mode
See all version on GitHub

README file from

Github

Obsidian Tidy Footnotes

Adds a command in Obsidian that tidies your footnotes so they're easy to follow:

  • Consolidates all footnote definitions into one place, sorted by appearance
  • Re-indexes numbered footnotes (e.g., [^1][^4][^2] becomes [^1][^2][^3])

Demo

Inspired by obsidian-footnotes plugin.

How to Install

From inside Obsidian:

  1. Go to Settings → Community plugins.
  2. Disable Safe mode.
  3. Click Browse, search for Tidy Footnotes, and click Install.
  4. Click the toggle button to enable the plugin.

For manual installation, download this repo and copy over main.js and manifest.json to your vault: VaultFolder/.obsidian/plugins/obsidian-tidy-footnotes/.

How to Use

Run Tidy Footnotes: Tidy Footnotes from the Command Palette. Or, set it as a hotkey from Settings → Hotkeys.

Caveats

  • Currently, footnotes in code blocks are also parsed instead of being ignored.
  • The original positions of footnote definitions are not maintained. The plugin will always move all definitions to where the first definition is found.
  • Non-numbered foonotes (e.g., [^abc]) doesn't affect the re-indexing of numbered footnotes.

Development

  1. Clone this repo.
  2. yarn to install dependencies.
  3. yarn dev to start compilation in watch mode.
  4. bash install-built.sh /path/to/your/vault -d to create symbolic links of built files to your vault for quick development.

Note: CodeMirror is imported for testing with the Doc interface. It may break in the future if the version no longer matches what Obsidian uses.

Release

  1. Run yarn build.
  2. Run npm version [patch/minor/major] to bump version in manifest.json and versions.json.
  3. Add changes in CHANGELOG.md.
  4. Add a new version tag and push it. 
    git tag -a 1.0.1 -m "1.0.1"
git push origin 1.0.1
  5. Go to “Releases” in GitHub and edit the latest release (created by GitHub Actions). Insert the changelog texts in the description and ensure main.js and manifest.json are attached.
  6. Click “Publish release”.

Support

If you really like this plugin and want to support its development, please consider buying me a coffee 🙂 Thanks!

Sponsors