📄 Add LICENSE

Author: Freed-Wu

.readthedocs.yaml

@@ -0,0 +1,18 @@
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+---
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
+
+formats:
+  - htmlzip
+
+python:
+  install:
+    - requirements: docs/requirements.txt

LICENSE

@@ -5,48 +5,16 @@ This project provides:
 - Language bindings for [tree-sitter-highlight](https://crates.io/crates/tree-sitter-highlight).
   - [python](crates/py-tree-sitter-highlight)
   - [lua](crates/lua-tree-sitter-highlight)
+  - [nodejs](crates/js-tree-sitter-highlight): TODO
 - Some packages to use tree-sitter to highlight
   - [sphinx](https://github.com/sphinx-doc/sphinx):
     [sphinxcontrib-tree-sitter](packages/sphinxcontrib-tree-sitter)
   - [ldoc](https://github.com/lunarmodules/ldoc):
     [texcat](https://texrocks.readthedocs.io/en/latest/topics/texcat.md.html)
-  - [LaTeX](https://www.latex-project.org/): also
+  - [pandoc](http://github.com/pandoc/pandoc):
     [texcat](https://texrocks.readthedocs.io/en/latest/topics/texcat.md.html)
-  - [pandoc](http://github.com/pandoc/pandoc): also
+  - [LaTeX](https://www.latex-project.org/):
     [texcat](https://texrocks.readthedocs.io/en/latest/topics/texcat.md.html)
+  - [hexo](https://github.com/hexojs/hexo): TODO
   - [jekyll](https://github.com/jekyll/jekyll): TODO
   - [typst](https://github.com/typst/typst): TODO
-
-## Bench
-
-<!-- markdownlint-disable MD013 -->
-
-```bash
-$ hyperfine -Nw10 'python -m sphinxcontrib.tree_sitter pyproject.toml' 'texcat pyproject.toml' 'tree-sitter highlight pyproject.toml' 'pygmentize pyproject.toml' 'bat pyproject.toml'
-Benchmark 1: python -m sphinxcontrib.tree_sitter pyproject.toml
-  Time (mean ± σ):     397.4 ms ±  64.9 ms    [User: 338.5 ms, System: 50.8 ms]
-  Range (min … max):   335.9 ms … 503.8 ms    10 runs
-
-Benchmark 2: texcat pyproject.toml
-  Time (mean ± σ):      1.782 s ±  0.041 s    [User: 1.174 s, System: 0.600 s]
-  Range (min … max):    1.746 s …  1.884 s    10 runs
-
-Benchmark 3: tree-sitter highlight pyproject.toml
-  Time (mean ± σ):       6.2 ms ±   0.4 ms    [User: 2.7 ms, System: 3.1 ms]
-  Range (min … max):     5.5 ms …   8.3 ms    394 runs
-
-Benchmark 4: pygmentize pyproject.toml
-  Time (mean ± σ):     262.4 ms ±   2.6 ms    [User: 236.6 ms, System: 23.0 ms]
-  Range (min … max):   258.9 ms … 268.5 ms    11 runs
-
-Benchmark 5: bat pyproject.toml
-  Time (mean ± σ):      12.6 ms ±   0.6 ms    [User: 10.4 ms, System: 5.7 ms]
-  Range (min … max):    11.6 ms …  14.9 ms    223 runs
-
-Summary
-  tree-sitter highlight pyproject.toml ran
-    2.04 ± 0.17 times faster than bat pyproject.toml
-   42.38 ± 2.87 times faster than pygmentize pyproject.toml
-   64.18 ± 11.32 times faster than python -m sphinxcontrib.tree_sitter pyproject.toml
-  287.79 ± 20.36 times faster than texcat pyproject.toml
-```

README.md

@@ -32,10 +32,10 @@
 )
 
 with open(PROJECT_FILE, "rb") as f:
-    data = tomllib.load(f)
-project = data["project"]
-author = project["authors"][0]["name"]
-project = project["name"]
+    data: dict = tomllib.load(f)
+project: dict = data["project"]
+author: str = project["authors"][0]["name"]
+project: str = project["name"]
 
 # -- General configuration ---------------------------------------------------
 
@@ -52,6 +52,9 @@
 ]
 
 myst_heading_anchors = 3
+myst_title_to_header = True
+myst_enable_extensions = ["tasklist"]
+todo_include_todos = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -66,10 +69,10 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
+html_theme = "furo"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 # html_static_path = ["_static"]
-html_favicon = "https://www.sphinx-doc.org/en/master/_static/favicon.svg"
+html_favicon = "https://tree-sitter.github.io/tree-sitter/favicon.png"

docs/conf.py

@@ -1,5 +1,14 @@
 <!-- markdownlint-disable MD041-->
 
+```{toctree}
+---
+hidden:
+glob:
+caption: resources
+---
+resources/*
+```
+
 ```{toctree}
 ---
 hidden:
@@ -16,8 +25,8 @@ search
 ```{include} ../crates/py-tree-sitter-highlight/README.md
 ```
 
-```{include} ../packages/sphinxcontrib-tree-sitter/README.md
+```{include} ../crates/lua-tree-sitter-highlight/README.md
 ```
 
-```{include} ../crates/lua-tree-sitter-highlight/README.md
+```{include} ../packages/sphinxcontrib-tree-sitter/README.md
 ```

docs/index.md

@@ -0,0 +1,3 @@
+#!/usr/bin/env -S pip install -r
+
+-e packages/sphinxcontrib-tree-sitter[docs]

docs/requirements.txt

@@ -0,0 +1,39 @@
+# Bench
+
+Installed parsers:
+
+- tree-sitter: 1
+- py-tree-sitter: 5
+- lua-tree-sitter: 338
+
+<!-- markdownlint-disable MD013 -->
+
+```bash
+$ hyperfine -Nw10 'python -m sphinxcontrib.tree_sitter pyproject.toml' 'texcat pyproject.toml' 'tree-sitter highlight pyproject.toml' 'pygmentize pyproject.toml' 'bat pyproject.toml'
+Benchmark 1: python -m sphinxcontrib.tree_sitter pyproject.toml
+  Time (mean ± σ):     397.4 ms ±  64.9 ms    [User: 338.5 ms, System: 50.8 ms]
+  Range (min … max):   335.9 ms … 503.8 ms    10 runs
+
+Benchmark 2: texcat pyproject.toml
+  Time (mean ± σ):      1.782 s ±  0.041 s    [User: 1.174 s, System: 0.600 s]
+  Range (min … max):    1.746 s …  1.884 s    10 runs
+
+Benchmark 3: tree-sitter highlight pyproject.toml
+  Time (mean ± σ):       6.2 ms ±   0.4 ms    [User: 2.7 ms, System: 3.1 ms]
+  Range (min … max):     5.5 ms …   8.3 ms    394 runs
+
+Benchmark 4: pygmentize pyproject.toml
+  Time (mean ± σ):     262.4 ms ±   2.6 ms    [User: 236.6 ms, System: 23.0 ms]
+  Range (min … max):   258.9 ms … 268.5 ms    11 runs
+
+Benchmark 5: bat pyproject.toml
+  Time (mean ± σ):      12.6 ms ±   0.6 ms    [User: 10.4 ms, System: 5.7 ms]
+  Range (min … max):    11.6 ms …  14.9 ms    223 runs
+
+Summary
+  tree-sitter highlight pyproject.toml ran
+    2.04 ± 0.17 times faster than bat pyproject.toml
+   42.38 ± 2.87 times faster than pygmentize pyproject.toml
+   64.18 ± 11.32 times faster than python -m sphinxcontrib.tree_sitter pyproject.toml
+  287.79 ± 20.36 times faster than texcat pyproject.toml
+```

docs/resources/bench.md

@@ -2,11 +2,16 @@
 
 Use tree-sitter to highlight code blocks.
 
+## Examples
+
+- [lsp-tree-sitter](https://lsp-tree-sitter.readthedocs.io/)
+- This website itself.
+
 ## Usage
 
 ### CLI
 
-```sh
+```bash
 python -m sphinxcontrib.tree_sitter /the/path/of/a/file
 ```
 
@@ -40,7 +45,7 @@ xdg-open _readthedocs/html/index.html
 
 ### markdown-it-py
 
-```python
+``````python
 from markdown_it import MarkdownIt
 from sphinxcontrib.tree_sitter.mdit_py_plugin import tree_sitter_plugin
 
@@ -51,4 +56,4 @@ def f():
     print("Hello")
 ```
 """)
-```
+``````

packages/sphinxcontrib-tree-sitter/README.md

@@ -17,8 +17,11 @@ homepage = "https://github.com/sphinx-contrib/tree-sitter-highlight"
 
 [project.optional-dependencies]
 dev = [
-  "myst-parser>=4",
   "pytest-cov>=7.1.0",
+]
+docs = [
+  "furo>=2025.12.19",
+  "myst-parser>=4",
   "tree-sitter-bash>=0.25",
   "tree-sitter-comment>=0.3.0",
   "tree-sitter-lua>=0.5.0",