insta-toc
v4.2.1
Published
Simultaneously generate, update, and maintain a table of contents for your notes in real time.
Downloads
1,808
Maintainers
Readme
Insta-Toc Plugin
A plugin to dyamically generate and maintain a table of contents while you're writing in real time.
Demo
Installation
COMING SOON: Obsidian Community Plugins Tab
TBD
BRAT
- Install BRAT community plugin.
- Open Obsidian and press SHIFT+CMD+P.
- Type
>BRAT: Plugins: Add a beta plugin for testing
and select the option. - Insert
https://github.com/iLiftALot/insta-toc
and submit.
Manual
- Download the latest release.
- Extract the
insta-toc
folder from the zip to your vault's plugins folder:/path/to/<vault>/.obsidian/plugins/
. Note: On some machines the .obsidian folder may be hidden. On MacOS you should be able to press Command+Shift+Dot to show the folder in Finder. - Reload Obsidian.
npm
npm install insta-toc
Contributing
Road Map
- [ ] Implement logic to handle various heading formats
- [x] Markdown Links
- [x] Wiki-Links
- [ ] TBD
- [ ] Configure Settings Tab
- [x] Indentation
- [x] Bullet types
- [x] Number
- [x] Dash
- [ ] TBD
- [x] Update Delay
- [ ] TBD
- [ ] Add preferences for customized TOC appearance
- [ ] TBD
- [x] Add folding capabilities