13
13
14
14
## Contents
15
15
16
- * [ What is this?] ( #what-is-this )
17
- * [ When should I use this?] ( #when-should-i-use-this )
18
- * [ Install] ( #install )
19
- * [ Use] ( #use )
20
- * [ API] ( #api )
21
- * [ ` unified().use(rehypeHighlight[, options]) ` ] ( #unifieduserehypehighlight-options )
22
- * [ ` Options ` ] ( #options )
23
- * [ Example] ( #example )
24
- * [ Example: ignoring] ( #example-ignoring )
25
- * [ Example: registering] ( #example-registering )
26
- * [ Example: aliases] ( #example-aliases )
27
- * [ Example: sanitation] ( #example-sanitation )
28
- * [ Types] ( #types )
29
- * [ Compatibility] ( #compatibility )
30
- * [ Security] ( #security )
31
- * [ Related] ( #related )
32
- * [ Contribute] ( #contribute )
33
- * [ License] ( #license )
16
+ * [ What is this?] ( #what-is-this )
17
+ * [ When should I use this?] ( #when-should-i-use-this )
18
+ * [ Install] ( #install )
19
+ * [ Use] ( #use )
20
+ * [ API] ( #api )
21
+ * [ ` unified().use(rehypeHighlight[, options]) ` ] ( #unifieduserehypehighlight-options )
22
+ * [ ` Options ` ] ( #options )
23
+ * [ Example] ( #example )
24
+ * [ Example: ignoring] ( #example-ignoring )
25
+ * [ Example: registering] ( #example-registering )
26
+ * [ Example: aliases] ( #example-aliases )
27
+ * [ Example: sanitation] ( #example-sanitation )
28
+ * [ Types] ( #types )
29
+ * [ Compatibility] ( #compatibility )
30
+ * [ Security] ( #security )
31
+ * [ Related] ( #related )
32
+ * [ Contribute] ( #contribute )
33
+ * [ License] ( #license )
34
34
35
35
## What is this?
36
36
@@ -143,8 +143,8 @@ Apply syntax highlighting.
143
143
144
144
###### Parameters
145
145
146
- * ` options ` ([ ` Options ` ] [ api-options ] , optional)
147
- — configuration
146
+ * ` options ` ([ ` Options ` ] [ api-options ] , optional)
147
+ — configuration
148
148
149
149
###### Returns
150
150
@@ -156,23 +156,23 @@ Configuration (TypeScript type).
156
156
157
157
###### Fields
158
158
159
- * ` aliases ` (` Record<string, Array<string> | string> ` , optional)
160
- — register more aliases;
161
- passed to [ ` lowlight.registerAlias ` ] [ lowlight-register-alias ]
162
- * ` detect ` (` boolean ` , default: ` false ` )
163
- — highlight code without language classes by guessing its programming
164
- language
165
- * ` languages ` (` Record<string, LanguageFn> ` , default:
166
- [ ` common ` ] [ lowlight-common ] )
167
- — register languages; passed to [ ` lowlight.register ` ] [ lowlight-register ]
168
- * ` plainText ` (` Array<string> ` , optional)
169
- — list of language names to not highlight;
170
- note you can also add ` no-highlight ` classes
171
- * ` prefix ` (` string ` , default: ` 'hljs-' ` )
172
- — class prefix
173
- * ` subset ` (` Array<string> ` , default: default: [ all] [ lowlight-all ] registered
174
- languages)
175
- — names of languages to check when detecting
159
+ * ` aliases ` (` Record<string, Array<string> | string> ` , optional)
160
+ — register more aliases;
161
+ passed to [ ` lowlight.registerAlias ` ] [ lowlight-register-alias ]
162
+ * ` detect ` (` boolean ` , default: ` false ` )
163
+ — highlight code without language classes by guessing its programming
164
+ language
165
+ * ` languages ` (` Record<string, LanguageFn> ` , default:
166
+ [ ` common ` ] [ lowlight-common ] )
167
+ — register languages; passed to [ ` lowlight.register ` ] [ lowlight-register ]
168
+ * ` plainText ` (` Array<string> ` , optional)
169
+ — list of language names to not highlight;
170
+ note you can also add ` no-highlight ` classes
171
+ * ` prefix ` (` string ` , default: ` 'hljs-' ` )
172
+ — class prefix
173
+ * ` subset ` (` Array<string> ` , default: default: [ all] [ lowlight-all ] registered
174
+ languages)
175
+ — names of languages to check when detecting
176
176
177
177
## Example
178
178
@@ -376,10 +376,10 @@ When in doubt, use [`rehype-sanitize`][rehype-sanitize].
376
376
377
377
## Related
378
378
379
- * [` rehype- meta` ](https://github.com/rehypejs/rehype-meta)
380
- — add metadata to the head of a document
381
- * [` rehype- document ` ](https://github.com/rehypejs/rehype-document)
382
- — wrap a fragment in a document
379
+ * [` rehype- meta` ](https://github.com/rehypejs/rehype-meta)
380
+ — add metadata to the head of a document
381
+ * [` rehype- document ` ](https://github.com/rehypejs/rehype-document)
382
+ — wrap a fragment in a document
383
383
384
384
## Contribute
385
385
0 commit comments