From 64c9b7afe975e6a984c4869d2ec7cc43b48be374 Mon Sep 17 00:00:00 2001 From: Romain Menke Date: Mon, 10 Apr 2023 12:06:14 +0200 Subject: [PATCH] css-tokenizer : documentation --- packages/css-tokenizer/CHANGELOG.md | 4 ++++ packages/css-tokenizer/README.md | 19 +++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/packages/css-tokenizer/CHANGELOG.md b/packages/css-tokenizer/CHANGELOG.md index 4bff3aaa8..f81c38ac6 100644 --- a/packages/css-tokenizer/CHANGELOG.md +++ b/packages/css-tokenizer/CHANGELOG.md @@ -1,5 +1,9 @@ # Changes to CSS Tokenizer +### Unreleased (patch) + +- Document `tokenize` helper function + ### 2.1.0 (February 21, 2023) - Add `tokenize` helper function diff --git a/packages/css-tokenizer/README.md b/packages/css-tokenizer/README.md index 6553cd714..810e47c8f 100644 --- a/packages/css-tokenizer/README.md +++ b/packages/css-tokenizer/README.md @@ -38,6 +38,25 @@ while (true) { } ``` +Or use the `tokenize` helper function: + +```js +import { tokenize } from '@csstools/css-tokenizer'; + +const myCSS = `@media only screen and (min-width: 768rem) { + .foo { + content: 'Some content!' !important; + } +} +`; + +const tokens = tokenize({ + css: myCSS, +}); + +console.log(tokens); +``` + ### Options ```ts