diff --git a/.gitignore b/.gitignore index ac08a4ba..862ff8a7 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,8 @@ node # Playwright playwright-report/ test-results/ + +# Local documentation (ignored) +LOCAL_LINK_GUIDE.md +WEB_GENERATOR_GUIDE.md +CLIENT_LINK_GUIDE.md diff --git a/src/generators/web/README.md b/src/generators/web/README.md index 17f8e138..445cc2ae 100644 --- a/src/generators/web/README.md +++ b/src/generators/web/README.md @@ -128,3 +128,42 @@ Since the template supports arbitrary JS expressions, you can use conditionals a ${importMap} ``` + +### Client-Side SPA Navigation (`ClientLink` & `navigate`) + +`doc-kit` provides a built-in zero-reload navigation solution for static web output without requiring browser storage (`sessionStorage`/`localStorage`). + +#### Features +- **Zero-Reload Navigation**: Intercepts internal link clicks (``), fetches target page HTML in the background, and updates the `#root` container. +- **Scroll Position Preservation**: Retains the sidebar (`