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

No description

Find a file

dragonish 3be4a6273f docs(images): optimize the size of images		2025-03-11 13:10:40 +08:00
.gitea	init: repository initialisation	2025-03-08 20:39:07 +08:00
.github	init: repository initialisation	2025-03-08 20:39:07 +08:00
common	feat: support independent configuration of decorators for each editor mode	2025-03-11 13:08:06 +08:00
components	feat: support independent configuration of decorators for each editor mode	2025-03-11 13:08:06 +08:00
images	docs(images): optimize the size of images	2025-03-11 13:10:40 +08:00
test/common	feat: add support to ignore the single heading at the top-level	2025-03-10 22:45:56 +08:00
.editorconfig	init: repository initialisation	2025-03-08 20:39:07 +08:00
.gitattributes	init: repository initialisation	2025-03-08 20:39:07 +08:00
.gitignore	init: repository initialisation	2025-03-08 20:39:07 +08:00
.mocharc.cjs	feat: implement decoration for reading view	2025-03-10 14:01:36 +08:00
.npmrc	init: repository initialisation	2025-03-08 20:39:07 +08:00
.versionrc.json	init: repository initialisation	2025-03-08 20:39:07 +08:00
esbuild.config.mjs	init: repository initialisation	2025-03-08 20:39:07 +08:00
eslint.config.mjs	config(eslint): add an eslint configuration	2025-03-08 21:58:29 +08:00
LICENSE	init: repository initialisation	2025-03-08 20:39:07 +08:00
main.ts	feat: support independent configuration of decorators for each editor mode	2025-03-11 13:08:06 +08:00
manifest.json	init: repository initialisation	2025-03-08 20:39:07 +08:00
package.json	feat: implement decoration for reading view	2025-03-10 14:01:36 +08:00
pnpm-lock.yaml	feat: implement decoration for reading view	2025-03-10 14:01:36 +08:00
README.md	docs(readme): add description	2025-03-10 23:51:26 +08:00
styles.css	fix(preview): fix decorator render exception when a heading other than current row is selected	2025-03-11 10:13:18 +08:00
tsconfig.json	init: repository initialisation	2025-03-08 20:39:07 +08:00
version-bump.mjs	init: repository initialisation	2025-03-08 20:39:07 +08:00
versions.json	init: repository initialisation	2025-03-08 20:39:07 +08:00

README.md

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

Settings

Enabled

Controls the scope of the decorator.

Enabled in Reading: 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 Ⓐ Ⓑ Ⓒ:

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

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

Unordered

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

Credits

@jsamr/counter-style

License

MIT license