Skip to content

Commit 97d911e

Browse files
authored
docs: clarify getSegments docs
1 parent 20f4fa8 commit 97d911e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,10 @@ The following options may be passed to the `highlight` function.
8989
}
9090
```
9191

92-
**Get segments for custom highlighter**
92+
## Custom highlighting
93+
94+
In case you want to do the highlighting yourself you can use `getSegments` to only let sql-highlight parse the SQL string for you. You can then use the segments to highlight it yourself.
95+
9396
```js
9497
const { getSegments } = require('sql-highlight')
9598

0 commit comments

Comments
 (0)