dragonish_obsidian-heading-.../README.md
dragonish 30b1f9cc87
docs(readme): add a description of the new setting
Add a description of the "Allow zero level" setting.

Refs: fb63af97d1
2025-03-13 10:32:59 +08:00

2.5 KiB

Heading Decorator

Obsidian Plugin

Introduction

This is a plugin for Obsidian.

Implements the decoration of the heading.

This plugin supports optional decoration for reading view, editing view (Live Preview) and source mode. This plugin does not modify any note content, only decorates the heading section based on the existing note content.

Preview

Preview

Settings

Enabled

The plugin supports configure heading decorator for each editor mode. You can control the effect range:

  • Enabled in reading view: Decorate the heading under the Reading view.
  • Enabled in live preview: Decorate the heading under the Live Preview.
  • Enabled in source mode: Decorate the heading under the Source mode.

Effect

Control the display effect of the decorator.

  • Ordered: Toggle this setting to enable the decoration of headings as an ordered or unordered list.
  • Opacity: Set the opacity of the heading decorator. The value is the form of percentage.
  • Position: Set the position of the heading decorator.

Ordered

Similar to the effect displayed in the Preview.

You can control the counter style type and delimiter. There are two special types of counter styles:

  • Custom list styles: Set custom list styles for ordered list. Using spaces to separate entries. For example, using Ⓐ Ⓑ Ⓒ:

Custom List Styles

  • Specified string: Set a specified string for ordered list. For example, using # with empty delimiter in reading view:

Specified String

In addition, for the Ignore the single heading at the top-level setting, if the top-level has only a single heading, exclude it when building an unordered list. For example:

Ignore the single heading at the top-level

For the Allow zero level setting, if the next heading is more than one level higher, the omitted level is zero instead of one. For example:

Default Allow zero level
omitted zero level

Unordered

Directly decorate the heading according to the level. For example, using H1 H2 H3 H4 H5 H6:

Unordered

Credits

License

MIT license