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]
)
Inspired by obsidian-footnotes plugin.
From inside Obsidian:
- Go to Settings β Community plugins.
- Disable Safe mode.
- Click Browse, search for Tidy Footnotes, and click Install.
- 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/tidy-footnotes/
.
Run Tidy Footnotes: Tidy Footnotes
from the Command Palette. Or, set it as a hotkey from Settings β Hotkeys.
- 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.
- Clone this repo.
npm i
oryarn
to install dependencies.npm run dev
to start compilation in watch mode.bash install-built.sh /path/to/your/vault -d
to create symbolic links of built files to your vault for quick development.npm run test
to run unit tests.
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.
- Run
yarn build
. - Bump version in
manifest.json
andversions.json
. - Add changes in
CHANGELOG.md
. - Add a new release in Github with the changelog texts and the built
main.js
andmanifest.json
attached.
If you really like this plugin and want to support its development, please consider buying me a coffee π Thanks!