obsidian-plugin/dragonish_obsidian-heading-decorator

mirror of https://github.com/dragonish/obsidian-heading-decorator.git synced 2026-07-22 05:42:05 +00:00

docs(readme): add a description about the support outline

Refs: d00a090099

2025-03-31 13:41:45 +08:00

3.8 KiB

Raw Blame History

Heading Decorator

Introduction

This is a plugin for Obsidian.

Implement displaying specific content around headings based on their levels.

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

Preview

In Live Preview:

The interaction between the decorator and the collapse button:

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.
Enabled in outline plugin: Decorate the heading under the Outline plugin.

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. You can configure the content to appear before or after the heading.

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.
Specified string: Set a specified string for ordered list.

For example:

Decimal numbers	Custom List Styles (using `Ⓐ Ⓑ Ⓒ`)	Specified String (using `#` with empty delimiter)

Based on the existing highest level

For the Based on the existing highest level setting, use the highest level of headings in the note as the base for ordered list. For example:

Default	Based on the existing highest level

Ignore the single heading at the top-level

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 ordered list. This setting contains Based on the existing highest level, but it deals with more "aggressive". For example: