obsidian-plugin/dragonish_obsidian-heading-decorator
1
0
Fork 0
mirror of https://github.com/dragonish/obsidian-heading-decorator.git synced 2026-07-22 05:42:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
18 commits 4 branches 26 tags 4.5 MiB
TypeScript 91.2%
CSS 7.5%
JavaScript 1.3%
Find a file
dragonish 20d2477c24
enh(editing): optimize the user experience in the editing view 
No longer using cache to parse headings, instead based on real-time
content and avoiding information asymmetry caused by cache latency.
2025-03-13 10:15:02 +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 enh(editing): optimize the user experience in the editing view 2025-03-13 10:15:02 +08:00
components enh(editing): optimize the user experience in the editing view 2025-03-13 10:15:02 +08:00
images docs(images): optimize the size of images 2025-03-11 13:10:40 +08:00
test/common enh(editing): optimize the user experience in the editing view 2025-03-13 10:15:02 +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 enh(editing): optimize the user experience in the editing view 2025-03-13 10:15:02 +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): update the description of the settings 2025-03-11 13:32:10 +08:00
styles.css enh: optimize the interaction between the decorator and the collapse button 2025-03-12 15:57:17 +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

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 item, 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

Unordered

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

Unordered

Credits

License

MIT license