这是indexloc提供的服务，不要输入任何密码
Skip to content

docs: plugin options #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 3, 2023
Merged

docs: plugin options #22

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
553fb68
docs: plugin options
hyoban Sep 24, 2023
f6f21ce
Merge branch 'main' into docs/options
hyoban Oct 2, 2023
142e922
update
hyoban Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ Then you can use the icons in your HTML:

Search the icon you want to use here: https://icones.js.org

### Plugin Options

| Option | Type | Default | Description |
| --------------- | ---------------------- | ------- | -------------------------------------------------- |
| prefix | string | `i` | Class prefix for matching icon rules |
| scale | number | `1` | Scale relative to the current font size |
| extraProperties | Record<string, string> | `{}` | Extra CSS properties applied to the generated CSS. |

### Custom Icons

You can also use custom icons with this plugin, for example:
Expand Down