From a2d4dc3a84a7fcfdb466ce83d4d3b0e3ef02b78a Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Tue, 22 Oct 2024 14:16:50 +0200 Subject: [PATCH] Add HTML, CSS sections to readme --- readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/readme.md b/readme.md index 014c182..769f873 100644 --- a/readme.md +++ b/readme.md @@ -27,6 +27,8 @@ * [Example: sanitation](#example-sanitation) * [Example: line numbering and highlighting](#example-line-numbering-and-highlighting) * [Types](#types) +* [HTML](#html) +* [CSS](#css) * [Compatibility](#compatibility) * [Security](#security) * [Related](#related) @@ -392,6 +394,19 @@ console.log(String(file)) This package is fully typed with [TypeScript][]. It exports the additional type [`Options`][api-options]. +## HTML + +On the input side, +this plugin looks for code blocks with a `language-*` class. + +On the output side, +this plugin generates `span` elements with classes that can be enhanced with +CSS. + +## CSS + +See [“CSS” in `lowlight`][github-lowlight-css] for more info. + ## Compatibility Projects maintained by the unified collective are compatible with maintained @@ -482,6 +497,8 @@ abide by its terms. [author]: https://wooorm.com +[github-lowlight-css]: https://github.com/wooorm/lowlight#css + [lowlight]: https://github.com/wooorm/lowlight [lowlight-all]: https://github.com/wooorm/lowlight#all