chore: default use_dot to false

matches the likec4 preview server, which uses the bundled wasm layout
engine. the previous default required graphviz to be installed and
silently produced layouts differing from the preview, which surprised
users. opt into graphviz with use_dot: true.

Author: jonas-haeusler

docs/index.md

@@ -5,7 +5,7 @@
 ## Requirements
 
 - [`likec4`](https://likec4.dev/tooling/cli/)
-- `graphviz` dependency (see also [use_dot](#use_dot) below)
+- `graphviz` (optional, only when [use_dot](#use_dot) is enabled)
 
 Check out the sample [Dockerfile](https://github.com/doubleSlashde/mkdocs-likec4/blob/main/Dockerfile) for how you can provide the likec4 and graphviz dependencies.
 
@@ -32,15 +32,15 @@ That's it! The plugin automatically:
 
 ### use_dot
 
-By default mkdocs-likec4 uses local graphviz binaries instead of bundled WASM (as it has [memory issues](https://github.com/likec4/likec4/issues?q=Memory%20type:Bug)).
+By default mkdocs-likec4 uses the bundled WASM layout engine, matching the behaviour of the `likec4` preview server.
 
-You can override it with the `use_dot: false` setting:
+You can opt into local graphviz binaries (which avoids known WASM [memory issues](https://github.com/likec4/likec4/issues?q=Memory%20type:Bug)) with `use_dot: true`. Note that this might result in a different layout than what the LikeC4 preview renders.
 
 ```yaml
 plugins:
   - search
   - likec4:
-      use_dot: false
+      use_dot: true
 ```
 
 ### color_scheme

mkdocs_likec4/generator.py

@@ -28,7 +28,7 @@ def generate(
         build_dir: str,
         site_dir: Path,
         *,
-        use_dot: bool = True,
+        use_dot: bool = False,
     ) -> None:
         """Generate web component JS file for a LikeC4 project."""
         if project_name is not None and not LikeC4Parser.is_valid_identifier(

mkdocs_likec4/plugin.py

@@ -21,7 +21,7 @@ class LikeC4Plugin(BasePlugin):
     """MkDocs plugin for embedding LikeC4 architecture diagrams."""
 
     config_scheme = (
-        ("use_dot", config_options.Type(bool, default=True)),
+        ("use_dot", config_options.Type(bool, default=False)),
         (
             "color_scheme",
             config_options.Choice(["auto", "light", "dark"], default="auto"),

tests/test_generator.py

@@ -53,7 +53,7 @@ def test_generate_default_project(self, mock_run, tmp_path):
         assert call_args[1] == "likec4"
         assert call_args[2] == "codegen"
         assert call_args[3] == "webcomponent"
-        assert "/docs" in call_args[4]
+        assert "/docs" in call_args
         assert "--webcomponent-prefix" not in call_args
         # Verify check=True is passed for proper error handling
         assert call_kwargs.get("check") is True
@@ -157,8 +157,8 @@ def test_generate_output_path(self, mock_run, tmp_path):
         assert "likec4_views_proj.js" in output_path
 
     @patch("mkdocs_likec4.generator.subprocess.run")
-    def test_generate_use_dot_true_by_default(self, mock_run, tmp_path):
-        """Test that --no-use-dot flag is not added by default (use_dot=True)."""
+    def test_generate_use_dot_false_by_default(self, mock_run, tmp_path):
+        """Test that --no-use-dot flag is added by default (use_dot=False)."""
         site_dir = tmp_path / "site"
         site_dir.mkdir()
 
@@ -170,11 +170,11 @@ def test_generate_use_dot_true_by_default(self, mock_run, tmp_path):
         )
 
         call_args = mock_run.call_args[0][0]
-        assert "--no-use-dot" not in call_args
+        assert "--no-use-dot" in call_args
 
     @patch("mkdocs_likec4.generator.subprocess.run")
-    def test_generate_use_dot_false(self, mock_run, tmp_path):
-        """Test that --no-use-dot flag is added when use_dot=False."""
+    def test_generate_use_dot_true(self, mock_run, tmp_path):
+        """Test that --no-use-dot flag is omitted when use_dot=True."""
         site_dir = tmp_path / "site"
         site_dir.mkdir()
 
@@ -183,8 +183,8 @@ def test_generate_use_dot_false(self, mock_run, tmp_path):
             project_dir=None,
             build_dir="/docs",
             site_dir=site_dir,
-            use_dot=False,
+            use_dot=True,
         )
 
         call_args = mock_run.call_args[0][0]
-        assert "--no-use-dot" in call_args
+        assert "--no-use-dot" not in call_args

tests/test_plugin.py

@@ -12,7 +12,7 @@
 def plugin():
     """Create a fresh plugin instance with default config."""
     p = LikeC4Plugin()
-    p.config = {"use_dot": True, "color_scheme": "auto"}
+    p.config = {"use_dot": False, "color_scheme": "auto"}
     return p
 
 
@@ -380,8 +380,8 @@ def test_skips_undiscovered_projects(self, mock_generate, plugin, tmp_path):
         assert call_args[0] == "proj1"
 
     @patch("mkdocs_likec4.plugin.WebComponentGenerator.generate")
-    def test_passes_use_dot_true_by_default(self, mock_generate, plugin, tmp_path):
-        """Test that use_dot defaults to True."""
+    def test_passes_use_dot_false_by_default(self, mock_generate, plugin, tmp_path):
+        """Test that use_dot defaults to False."""
         plugin.docs_dir = tmp_path / "docs"
         plugin.docs_dir.mkdir()
         plugin.project_map = {"proj": "proj"}
@@ -394,18 +394,18 @@ def test_passes_use_dot_true_by_default(self, mock_generate, plugin, tmp_path):
         plugin.on_post_build(config)
 
         mock_generate.assert_called_once()
-        assert mock_generate.call_args.kwargs["use_dot"] is True
+        assert mock_generate.call_args.kwargs["use_dot"] is False
 
     @patch("mkdocs_likec4.plugin.WebComponentGenerator.generate")
-    def test_passes_use_dot_false_when_configured(
+    def test_passes_use_dot_true_when_configured(
         self, mock_generate, plugin, tmp_path
     ):
-        """Test that use_dot=False is passed when configured."""
+        """Test that use_dot=True is passed when configured."""
         plugin.docs_dir = tmp_path / "docs"
         plugin.docs_dir.mkdir()
         plugin.project_map = {"proj": "proj"}
         plugin.page_projects = {"page.md": {"proj"}}
-        plugin.config["use_dot"] = False
+        plugin.config["use_dot"] = True
 
         site_dir = tmp_path / "site"
         site_dir.mkdir()
@@ -414,7 +414,7 @@ def test_passes_use_dot_false_when_configured(
         plugin.on_post_build(config)
 
         mock_generate.assert_called_once()
-        assert mock_generate.call_args.kwargs["use_dot"] is False
+        assert mock_generate.call_args.kwargs["use_dot"] is True
 
 
 class TestColorScheme: