https://github.com/charliecm/obsidian-tidy-footnotes
Tidy your footnotes seamlessly in Obsidian.
https://github.com/charliecm/obsidian-tidy-footnotes
automation document footnotes obsidian obsidian-md obsidian-plugin productivity tidy writing
Last synced: 6 months ago
JSON representation
Tidy your footnotes seamlessly in Obsidian.
- Host: GitHub
- URL: https://github.com/charliecm/obsidian-tidy-footnotes
- Owner: charliecm
- Created: 2021-04-12T01:50:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T16:50:48.000Z (over 1 year ago)
- Last Synced: 2024-08-13T07:18:10.751Z (about 1 year ago)
- Topics: automation, document, footnotes, obsidian, obsidian-md, obsidian-plugin, productivity, tidy, writing
- Language: TypeScript
- Homepage:
- Size: 327 KB
- Stars: 46
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- jimsghstars - charliecm/obsidian-tidy-footnotes - Tidy your footnotes seamlessly in Obsidian. (TypeScript)
README
# Obsidian Tidy Footnotes
Adds a command in [Obsidian](https://obsidian.md) that tidies your [footnotes](https://help.obsidian.md/How+to/Format+your+notes#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](https://github.com/akaalias/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](https://github.com/codemirror/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](https://www.buymeacoffee.com/charliecm) 🙂 Thanks!
