https://github.com/iliftalot/insta-toc

Simultaneously generate, update, and maintain a table of contents for your notes in real time.
https://github.com/iliftalot/insta-toc

obsidian obsidian-md obsidian-plugin obsidian-table-of-contents obsidian-toc table-of-contents-generator

Last synced: about 1 month ago
JSON representation

Simultaneously generate, update, and maintain a table of contents for your notes in real time.

• Host: GitHub
• URL: https://github.com/iliftalot/insta-toc
• Owner: iLiftALot
• License: mit
• Created: 2024-11-11T14:57:53.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-11-18T21:27:50.000Z (about 1 month ago)
• Last Synced: 2024-11-20T00:15:16.952Z (about 1 month ago)
• Topics: obsidian, obsidian-md, obsidian-plugin, obsidian-table-of-contents, obsidian-toc, table-of-contents-generator
• Language: TypeScript
• Homepage:
• Size: 4.41 MB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Insta-Toc Plugin

[![Version](https://img.shields.io/github/v/release/iLiftALot/insta-toc?include_prereleases&label=latest&color=blue)](https://github.com/iLiftALot/insta-toc/releases)

[![Test](https://github.com/iLiftALot/insta-toc/actions/workflows/test.yml/badge.svg)](https://github.com/iLiftALot/insta-toc/actions)

A plugin to dyamically generate and maintain a table of contents for you in real time.

## Demo

![./assets/media/assets/media/demonstration.gif](https://raw.githubusercontent.com/iLiftALot/insta-toc/master/assets/media/demonstration.gif)

## Installation

### **COMING SOON**: Obsidian Community Plugins Tab

*TBD*

### BRAT

1. Install [BRAT](https://github.com/TfTHacker/obsidian42-brat) community plugin.

2. Open Obsidian and press SHIFT+CMD+P.

3. Type `>BRAT: Plugins: Add a beta plugin for testing` and select the option.

4. Insert `https://github.com/iLiftALot/insta-toc` and submit.

### Manual

1. Download the [latest release](https://github.com/iLiftALot/insta-toc/releases).

2. Extract the `insta-toc` folder from the zip to your vault's plugins folder: `/path/to//.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.

3. Reload Obsidian.

### npm

```shell

npm install insta-toc

```

## Contributing

- [Report a Bug](https://github.com/iLiftALot/insta-toc/issues/new?assignees=iLiftALot&labels=bug&template=&title=Bug%3A+)

- [Suggest a Feature](https://github.com/iLiftALot/insta-toc/issues/new?assignees=iLiftALot&labels=feature-request&template=&title=FR%3A+)

- [Suggest Documentation](https://github.com/iLiftALot/insta-toc/issues/new?assignees=iLiftALot&labels=documentation&template=&title=Doc%3A+)

- [Submit a Pull Request](https://github.com/iLiftALot/insta-toc/pulls)

## Road Map

- [ ] Handle various heading formats

  - [x] Markdown Links

  - [x] Wiki-Links

  - [x] HTML

  - [x] Tags

  - [x] Special Characters

  - [ ] TBD

- [ ] Configure Settings Tab

  - [x] Indentation

  - [x] Bullet types

    - [x] Number

    - [x] Dash

    - [ ] TBD

  - [x] ToC Update Delay

  - [x] Special Character Specifications

  - [ ] Preferences for customized TOC appearance

  - [ ] TBD

- [x] Add folding capabilities