{"slug": "documentation-is-insurance-for-the-future", "title": "Documentation is insurance for the future", "summary": "Synlace released a Starlight documentation scaffold that adds a searchable, themed documentation site to any project with a single command. The scaffold includes dark/light mode, full-text search, sidebar navigation, Mermaid diagrams, and mobile responsiveness, and is downloaded as a tarball from GitHub without submodules or build services.", "body_md": "Starlight documentation scaffold for any project.\n\nOne command to add a searchable, themed documentation site to your repo.\n\n```\ncurl -fsSL https://github.com/synlace/project-docs/raw/main/init.sh | bash\n```\n\nTo get the latest SHA, check the [latest commit](https://github.com/synlace/project-docs/commits/main).\n\n*Example documentation site for Marlint, a real-time AI phishing detection browser extension.*\n\n```\nproject/\n├── project-docs/          # Starlight docs site\n│   ├── package.json\n│   ├── astro.config.mjs   # edit title, sidebar, social links\n│   └── src/content/docs/  # your documentation pages\n│       └── index.mdx\n├── justfile-doc            # just recipes (import into justfile)\n└── justfile                # auto-created with import if missing\n```\n\n- Dark / light mode\n- Full-text search\n- Sidebar navigation\n- Mermaid diagrams\n- Mobile responsive\n- Static HTML output (\n`npm run build`\n\n)\n\nOnce imported, run from your project root:\n\n| Command | Description |\n|---|---|\n`just doc` |\nStart dev server |\n`just doc init` |\nInstall npm dependencies |\n`just doc build` |\nBuild static site |\n`just doc preview` |\nPreview production build |\n`just doc uninstall` |\nRemove scaffold and import |\n\nThe template is downloaded as a tarball from GitHub. No submodules, no npm publishing, no build service. Each project owns its `project-docs/`\n\ndirectory — edits config, writes content, commits everything to its own repo.\n\nThe template is a starting point, not a dependency. To pull in config improvements later:\n\n```\nSHA=$(curl -fsSL https://api.github.com/repos/synlace/project-docs/commits/main | python3 -c \"import sys,json; print(json.load(sys.stdin)['sha'][:7])\")\ndiff -rq project-docs/ <(curl -fsSL \"https://github.com/synlace/project-docs/archive/$SHA.tar.gz\" | tar -xz --strip-components=1)\n```\n\nCherry-pick what you want.", "url": "https://wpnews.pro/news/documentation-is-insurance-for-the-future", "canonical_source": "https://github.com/synlace/project-docs", "published_at": "2026-07-23 15:45:32+00:00", "updated_at": "2026-07-23 15:52:15.254633+00:00", "lang": "en", "topics": ["developer-tools"], "entities": ["Synlace", "Starlight", "GitHub", "Marlint"], "alternates": {"html": "https://wpnews.pro/news/documentation-is-insurance-for-the-future", "markdown": "https://wpnews.pro/news/documentation-is-insurance-for-the-future.md", "text": "https://wpnews.pro/news/documentation-is-insurance-for-the-future.txt", "jsonld": "https://wpnews.pro/news/documentation-is-insurance-for-the-future.jsonld"}}