Skip to content

Commit a2d4dc3

Browse files
committed
Add HTML, CSS sections to readme
1 parent 2db24d3 commit a2d4dc3

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

readme.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
* [Example: sanitation](#example-sanitation)
2828
* [Example: line numbering and highlighting](#example-line-numbering-and-highlighting)
2929
* [Types](#types)
30+
* [HTML](#html)
31+
* [CSS](#css)
3032
* [Compatibility](#compatibility)
3133
* [Security](#security)
3234
* [Related](#related)
@@ -392,6 +394,19 @@ console.log(String(file))
392394
This package is fully typed with [TypeScript][].
393395
It exports the additional type [`Options`][api-options].
394396
397+
## HTML
398+
399+
On the input side,
400+
this plugin looks for code blocks with a `language-*` class.
401+
402+
On the output side,
403+
this plugin generates `span` elements with classes that can be enhanced with
404+
CSS.
405+
406+
## CSS
407+
408+
See [“CSS” in `lowlight`][github-lowlight-css] for more info.
409+
395410
## Compatibility
396411
397412
Projects maintained by the unified collective are compatible with maintained
@@ -482,6 +497,8 @@ abide by its terms.
482497
483498
[author]: https://wooorm.com
484499
500+
[github-lowlight-css]: https://github.com/wooorm/lowlight#css
501+
485502
[lowlight]: https://github.com/wooorm/lowlight
486503
487504
[lowlight-all]: https://github.com/wooorm/lowlight#all

0 commit comments

Comments
 (0)