onlyafly / number-headings-obsidian

Automatically number headings in a document in Obsidian
MIT License
119 stars 14 forks source link

Number Headings Plugin for Obsidian

Add numbers to headings in a doc with outline style numbering. For example, "1.1.2".

How to install

There are two ways to get the plugin:

  1. Install the latest release from Obsidian directly. Go to Settings -> Community Plugins -> Browse.
  2. Unzip the most recent release into your <vault>/.obsidian/plugins/ folder. You can find the latest release at https://github.com/onlyafly/number-headings-obsidian/releases/latest.

After you have installed the plugin, make sure that the switch for "Number Headings" is turned on.

How to use the plugin

To use this plugin:

  1. Open the command palette (type CMD + P on Mac or its equivalent on other platforms).
  2. Start typing the name of one of the actions. See below:
Action Hotkey
Number all headings in document (and show options) None by default
Number all headings in document None by default
Remove numbering from all headings in document None by default
Save settings to front matter None by default

You can also assign the commands to hotkeys for easy usage.

See the settings page for the plugin for detailed instructions on the various settings you can use with the plugin.

Version History

1.16.0 (Oct 3, 2023)

1.15.0 (Sep 23, 2023)

1.14.0 (Sep 21, 2023)

1.13.0 (Jan 6, 2023)

1.12.0 (Jan 1, 2023)

1.11.0 (Jan 1, 2023)

1.10.1 (Dec 31, 2022)

1.10.0 (June 29, 2022)

1.9.0 (June 19, 2022)

1.8.1 (December 15, 2021)

1.8.0 (October 26, 2021)

1.7.3 (August 24, 2021)

1.7.2 (August 19, 2021)

1.7.1 (August 18, 2021)

1.7.0 (August 18, 2021)

1.6.1 (August 15, 2021)

1.6.0 (August 14, 2021)

1.5.1 (August 14, 2021)

Credits

I was inspired partially by the Obsidian plugin https://github.com/hipstersmoothie/obsidian-plugin-toc and some of the code logic is descended from that plugin. Thanks!