dragonish_obsidian-heading-.../README.md

66 lines
2.1 KiB
Markdown
Raw Normal View History

2025-03-08 12:39:07 +00:00
# Heading Decorator
> Obsidian Plugin
## Introduction
This is a plugin for [Obsidian](https://obsidian.md).
Implements the decoration of the heading.
2025-03-10 15:51:26 +00:00
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](images/preview.jpg)
## 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](#ordered) or [unordered](#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](#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](images/custom-list-styles.jpg)
- **Specified string**: Set a specified string for ordered list. For example, using `#` with empty delimiter in reading view:
![Specified String](images/specified-string.jpg)
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](images/ignore-single-heading.jpg)
### Unordered
Directly decorate the heading according to the level. For example, using `H1 H2 H3 H4 H5 H6`:
![Unordered](images/unordered.jpg)
## Credits
- [@jsamr/counter-style](https://github.com/jsamr/react-native-li/tree/master/packages/counter-style#readme)
## License
[MIT](/LICENSE) license