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
56 commits 4 branches 26 tags 4.5 MiB
TypeScript 91.2%
CSS 7.5%
JavaScript 1.3%
Find a file
dragonish 25fbd35d8f
fix(settings): add missing settings tab name
2025-04-01 19:38:09 +08:00
.gitea ci(gitea): restore the tag-changelog action 2025-03-19 23:08:14 +08:00
.github init: repository initialisation 2025-03-08 20:39:07 +08:00
common docs(dom): format comment 2025-03-31 14:55:02 +08:00
components feat(outline): add support for outline plugin 2025-03-31 13:41:04 +08:00
images docs(images): update example images 2025-03-27 22:06:20 +08:00
test/common tweak(outline): handle cases where the heading contains html 2025-03-31 14:45:54 +08:00
.editorconfig init: repository initialisation 2025-03-08 20:39:07 +08:00
.gitattributes config(git): specify the eol of the manifest.json file 2025-03-15 20:05:28 +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 fix(settings): add missing settings tab name 2025-04-01 19:38:09 +08:00
manifest.json chore(release): 1.3.0 2025-04-01 19:25:23 +08:00
package.json chore(release): 1.3.0 2025-04-01 19:25:23 +08:00
pnpm-lock.yaml chore(package): replace dependencies 2025-03-27 20:10:40 +08:00
README.md docs(readme): add a description about the support outline 2025-03-31 13:41:45 +08:00
styles.css fix(styles): fix decorator not render when losing focus in edit view 2025-03-31 20:37:08 +08:00
tsconfig.json feat(outline): add support for outline plugin 2025-03-31 13:41:04 +08:00
types.d.ts feat(outline): add support for outline plugin 2025-03-31 13:41:04 +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

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:

Preview

The interaction between the decorator and the collapse button:

Collapse Button Interaction

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)
Decimal numbers Custom list styles Specified string

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
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:

Default Ignore the single heading at the top-level
Default Ignore the single heading at the top-level

Allow zero 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
Default Allow zero level

Unordered

Directly decorate the heading according to the level. For example:

Ordered (Decimal numbers) Unordered (using H1 H2 H3 H4 H5 H6)
Ordered Unordered

Credits

License

MIT license