docs: add mdbook-admonish for better tooltips

This commit is contained in:
Amaan Qureshi 2025-01-10 02:29:32 -05:00
parent c8bd78a29c
commit 21d74b8482
15 changed files with 435 additions and 48 deletions

View file

@ -11,8 +11,9 @@ These directories are created in the "default" location for your platform:
* On Unix, `$XDG_CONFIG_HOME/tree-sitter` or `$HOME/.config/tree-sitter`
* On Windows, `%APPDATA%\tree-sitter` or `$HOME\AppData\Roaming\tree-sitter`
> Note that the CLI will work if there's no config file present, falling back on default values > for each configuration
> option.
```admonish info
The CLI will work if there's no config file present, falling back on default values for each configuration option.
```
When you run the `init-config` command, it will print out the location of the file that it creates so that you can easily
find and modify it.
@ -113,8 +114,13 @@ An example theme can be seen below:
## `parse-theme`
The [`tree-sitter parse`](./parse.md) command will output a pretty-printed CST when the `-c/--cst` option is used. You can
control what colors are used for various parts of the tree in your configuration file. Note that omitting a field will cause
the relevant text to be rendered with its default color.
control what colors are used for various parts of the tree in your configuration file.
```admonish note
Omitting a field will cause the relevant text to be rendered with its default color.
```
An example parse theme can be seen below:
```json
{

View file

@ -6,8 +6,10 @@ The `playground` command allows you to start a local playground to test your par
tree-sitter playground [OPTIONS] # Aliases: play, pg, web-ui
```
Note that you must have already built the parser as a WASM module. This can be done with the [`build`](./build.md) subcommand
```admonish note
For this to work, you must have already built the parser as a WASM module. This can be done with the [`build`](./build.md) subcommand
(`tree-sitter build --wasm`).
```
## Options

View file

@ -18,7 +18,11 @@ Skip tests whose names match this regex.
### `-u/--update`
Update the expected output of tests. Note that tests containing `ERROR` nodes or `MISSING` nodes will not be updated.
Update the expected output of tests.
```admonish info
Tests containing `ERROR` nodes or `MISSING` nodes will not be updated.
```
### `-d/--debug`