Automatic Renumbering
by Omri Levi
favorite
share
Description

The Automatic Renumbering Plugin for Obsidian is designed to keep your numbered lists in perfect order as you work. This tool automatically updates list numbers in real-time, saving you the hassle of manually adjusting them after edits. Whether you're adding new items, pasting content, or undoing changes, the plugin ensures your list remains sequential. It features smart pasting for consistent numbering when you paste content and provides manual control for those who prefer to update the numbers themselves. You can also renumber selected sections or entire notes with a few commands. Perfect for users working with large structured documents, this plugin helps you stay organized without any performance issues, even with extensive lists. However, it does not support Vim mode or automatic tab size detection for nested lists.

Latest Version
13 days ago
Changelog

Release 1.0.0 - Initial Release

Overview

The first official release of the Automatic Renumbering plugin for Obsidian. This plugin helps keep your numbered lists in sequential order automatically, which is particularly useful for users who frequently work with structured documents.

Notable Features

  • Live Updates: Automatically renumbers lists as you edit, helping maintain accurate sequencing without manual adjustments.
  • Pasting Support: Ensures correct numbering when pasting content.
  • Manual Control: Offers commands for manual renumbering if you prefer to manage updates yourself.

Installation Steps

To get started with the Automatic Renumbering Plugin, follow these steps:

  1. Download the latest release files.
  2. Create a folder for the files and place that folder in the plugins folder. You can find this by opening Obsidian and navigating to Options → Community plugins, where you'll see the folder icon and the refresh button next to Installed plugins.
  3. Click the refresh button.
  4. Enable the plugin in Settings > Community plugins.
  5. In the plugin settings, match the tab size to the editor’s tab indent size, which can be found under Options → Editor → Tab indent size.

Usage Commands

You can view the available commands by pressing Ctrl + P.

  • Renumber at Cursor: This command will renumber the list starting from the current cursor position.
  • Renumber Selected Lists: If you highlight multiple numbered lists, this command renumbers all of them at once.
  • Renumber Entire Note: This command renumbers every numbered list in your active note.

Performance

The plugin has been tested with documents containing lists over 10,000 lines and no performance issues were found.

Limitations

The plugin does not support automatic renumbering in Vim mode, but you can still trigger renumbering commands manually. Additionally, it requires manual specification of tab sizes for correct nested numbering, as automatic detection is not available.

License Information

This project is licensed under the MIT License, allowing for both personal and commercial use.

README file from