Add pyvis html render to documentation (#394)

kayjan · web-flow · commit d839325ffd76 · 2025-07-31T22:35:03.000+08:00
docs: add pyvis html render
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added:
 - Tree Render: `render_tree` to accept theme argument.
+- Docs: Add pyvis html render to Tree Demonstration.
 
 ## [0.29.2] - 2025-05-15
 ### Added:
diff --git a/docs/gettingstarted/demo/tree.md b/docs/gettingstarted/demo/tree.md
@@ -343,7 +343,7 @@ After tree is constructed, it can be viewed by printing to console using `show`,
 for compact, horizontal, and vertical orientation respectively.
 Alternatively, the `print_tree`, `hprint_tree`, or `vprint_tree` method can be used.
 
-```python hl_lines="8 15"
+```python hl_lines="8 15 21"
 from bigtree import Node, print_tree, hprint_tree, vprint_tree
 
 root = Node("a", alias="alias-a", age=90, gender="F")
@@ -1372,3 +1372,14 @@ flowchart TB
 0("a") --> 0-1("c")
 classDef default stroke-width:1
 ```
+
+- Pyvis network
+
+<div style="background-color: white;">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/vis-network/9.1.2/dist/vis-network.min.js" integrity="sha512-LnvoEWDFrqGHlHmDD2101OrLcbsfkrzoSpvtSQtxK3RMnRV0eOkhhBN2dXHKRrUU8p2DGRTk35n4O8nWSVe1mQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+{%
+    include-markdown "../../../assets/demo/vis.html"
+    start="<body>"
+    end="</body>"
+%}
+</div>
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,6 +3,7 @@ IPython
 mdx_truly_sane_lists==1.3
 mkdocs==1.5.3
 mkdocs-glightbox==0.3.7
+mkdocs-include-markdown-plugin
 mkdocs-jupyter
 mkdocs-material[imaging]==9.5.17
 mkdocstrings[python]>=0.25.0  # griffe.collections error
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -104,6 +104,7 @@ plugins:
   - mkdocs-jupyter:
       ignore_h1_titles: True
   - search
+  - include-markdown
   - social:
       cards_layout_options:
         logo: docs/_static/favicon.svg
diff --git a/pyproject.toml b/pyproject.toml
@@ -113,6 +113,7 @@ dependencies = [
   "IPython",
   "mkdocs==1.5.3",
   "mkdocs-glightbox",
+  "mkdocs-include-markdown-plugin",
   "mkdocs-jupyter",
   "mkdocs-material[imaging]==9.5.17",
   "mdx_truly_sane_lists==1.3",
