PHPackages simai/docara - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Templating & Views](/categories/templating) 4. / 5. simai/docara ActiveLibrary[Templating & Views](/categories/templating) simai/docara ============ Portable static documentation and landing sites from Markdown and validated JSON with Simai Framework v1.3.66(1mo ago)0528MITPHPPHP ^8.2CI passing Since Nov 28Pushed 1w agoCompare [ Source](https://github.com/simai/docara)[ Packagist](https://packagist.org/packages/simai/docara)[ RSS](/packages/simai-docara/feed)WikiDiscussions main Synced 1w ago READMEChangelogDependencies (75)Versions (140)Used By (0) Docara ====== [](#docara) Docara builds static documentation, reference sites and small landing pages from Markdown and validated JSON. SIMAI Framework supplies the interface; authors do not need Node.js or a frontend toolchain. Quick start ----------- [](#quick-start) Until Docara 2 is published, run these commands from an exact source checkout: ``` git rev-parse HEAD composer install php docara init /path/to/my-docara cd /path/to/my-docara php /path/to/docara/docara build production php /path/to/docara/docara verify-static build_production php /path/to/docara/docara serve production --host=127.0.0.1 --port=8000 --no-build ``` Open `http://127.0.0.1:8000`. Do not use `file://`: routes, search and assets must be checked through HTTP. The starter contains one product model: ``` docara.json site, locales, preset and Framework lock reference redirects.json explicit redirects simai-framework.lock.json immutable Framework revisions assets/ project-owned public assets content// Markdown and inherited JSON settings .docara/engine/ package-owned engine snapshot and ownership manifest ``` Settings resolve deterministically: ``` built-in defaults → docara.json → section.json from the locale root to the page → .page.json → Markdown content ``` One build publishes every locale declared in `docara.json`. A documentation version is a separate site variant and output with its own `base_url`. Commands -------- [](#commands) ``` php vendor/bin/docara init [path] php vendor/bin/docara update [path] --verify php vendor/bin/docara update [path] --dry-run php vendor/bin/docara update [path] --apply php vendor/bin/docara update [path] --rollback=latest php vendor/bin/docara build [environment] [--page=/public/url/] php vendor/bin/docara serve [environment] [--no-build] php vendor/bin/docara verify-static [build-directory] php vendor/bin/docara doctor [--json] php vendor/bin/docara list smart|layout|view|section|block|provider|fixture|state|schema [--json] php vendor/bin/docara inspect smart|layout|view|section|block|provider|fixture|state|schema [--json] php vendor/bin/docara schema smart|layout|view|section|block [--json] php vendor/bin/docara scaffold smart|design --dry-run [--json] php vendor/bin/docara scaffold --apply= [--json] php vendor/bin/docara validate project|smart|layout|view|section|block [id] [--json] php vendor/bin/docara test smart|layout --page=/public/route/ [--json] php vendor/bin/docara qa smart|region|layout --page=/public/route/ --dry-run [--json] php vendor/bin/docara qa --finalize-reference= [--json] php vendor/bin/docara qa --verify= [--json] ``` `schema smart` возвращает neutral `sf.smart_artifact_abi` v1 manifest schema, которой напрямую проверяется результат `scaffold smart`; package compatibility adapters не являются вторым публичным Smart-форматом. For layout test/QA, the selected page must actually resolve that layout; a context mismatch fails closed instead of testing a different production page. Each QA run uses an explicit immutable chain. `qa ... --dry-run` creates a content-addressed draft plan. Optional browser tooling records the planned reference screenshots under that draft. PHP then validates every screenshot and `qa --finalize-reference` creates a new finalized plan whose `reference_id` covers the complete ordered reference manifest: target, page and artifact hashes, scenario IDs, paths and screenshot hashes. Only that finalized plan may produce a report or pass `qa --verify`. Verification recalculates the full reference identity and manifest seal, re-hashes the preview and PNG bytes, and never trusts a reported zero pixel count on its own. `init` accepts only an empty target. Updating is an explicit transaction: verify ownership, write and review a hash-bound dry-run plan, then apply that unchanged plan. Apply replaces only `.docara/engine`, records an immutable rollback package and never targets `content/**`, `assets/**`, `docara.json`, section/page settings, locale files or the consumer-owned `composer.lock`. Unknown, dirty, conflicting or symlinked ownership fails closed. Generated `build_*` files and package-owned `.docara` state must not be edited manually. The optional `path` may be absolute or relative to the current directory. If it is omitted, `init` and `update` use the current directory. `init --update` is a disabled compatibility guard and prints the explicit update workflow. After one complete build, changing one Markdown owner and using `--page`atomically rebuilds only that existing route through the same PageBuilder. Adding, renaming or deleting a route requires a complete build so navigation, search, redirects and receipts change together. Run a complete build after other structural, global configuration or Framework lock changes as well. The developer SDK uses one operation result for human and `--json` output. Scaffolding is never a one-step write: review the deterministic dry-run diff, then apply its exact SHA-256 plan. Only project-owned `smart/` and `design/`sources can be created. Validation, test and QA delegate the production registries and PreviewKernel. The optional PHP stdio MCP adapter is `tools/mcp-docara/server.php`; it is read-only unless started explicitly with `--allow-writes`, and even then apply requires the unchanged dry-run plan. Documentation ------------- [](#documentation) - [How the engine is organized](docs/site/content/ru/development/architecture.md) - [Developer and AI SDK](docs/site/content/ru/development/developer-sdk.md) - [Quick start](docs/site/content/ru/start.md) - [Project files and configuration](docs/site/content/ru/authoring/project-files.md) - [Layouts, regions and navigation](docs/site/content/ru/authoring/layout-and-navigation.md) - [Components](docs/site/content/ru/components.md) - [Build and verification](docs/site/content/ru/build.md) - [Portable project format](docs/site/content/ru/authoring/project-files.md) The component index, menu, search, outline and previous/next links are derived from the same physical Markdown route set; there is no separate public page catalogue. Repository checks ----------------- [](#repository-checks) ``` php vendor/bin/pint --test php vendor/bin/phpunit cd docs/site php ../../docara build production php ../../docara verify-static build_production ``` This branch is a Docara 2 candidate. It does not itself claim a public release or production readiness. Local release-readiness check ----------------------------- [](#local-release-readiness-check) Release packaging is an exact-revision, non-publishing operation. Run it only from a clean checkout and pass a planned version/tag as parameters: ``` REVISION=$(git rev-parse HEAD) PLANNED_VERSION="replace-with-approved-version" PLANNED_TAG="replace-with-approved-tag" php scripts/build-release-package.php \ --revision="$REVISION" \ --version="$PLANNED_VERSION" \ --tag="$PLANNED_TAG" \ --output=build_release php scripts/verify-release-package.php \ "build_release/docara-$PLANNED_VERSION.release-manifest.json" ``` The command reads only committed blobs from that exact revision. It writes a deterministic ZIP, a paired manifest containing the archive checksum and full file ledger, a checksum file and an in-archive CycloneDX dependency inventory. The package excludes VCS, CI, tests, graph, workflow evidence, caches and credentials. `published=false` and the tag is only a planned parameter: no tag, GitHub release or package publication is created. Before an approved release, build twice in independent clean clones, install both ZIPs into fresh Composer consumers, verify their consumer-owned locks, run init/update/build/static/browser checks, and retain the exact rollback and smoke plan. See [publishing and rollback](docs/site/content/ru/build/publish.md). License ------- [](#license) MIT ### Health Score 50 — FairBetter than 95% of packages Maintenance96 Actively maintained with recent releases Popularity17 Limited adoption so far Community8 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor1 Top contributor holds 73.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~2 days Total 139 Last Release 30d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/25454091?v=4)[Alexander](/maintainers/Burundug)[@Burundug](https://github.com/Burundug) --- Top Contributors [![zabarov](https://avatars.githubusercontent.com/u/30549385?v=4)](https://github.com/zabarov "zabarov (410 commits)")[![Burundug](https://avatars.githubusercontent.com/u/25454091?v=4)](https://github.com/Burundug "Burundug (149 commits)") --- Tags laravelgeneratorbladestaticsitesimaisf5 ### Code Quality TestsPHPUnit Code StyleLaravel Pint ### Embed Badge ![Health badge](/badges/simai-docara/health.svg) ``` [![Health](https://phpackages.com/badges/simai-docara/health.svg)](https://phpackages.com/packages/simai-docara) ``` ### Alternatives [tightenco/jigsaw Simple static sites with Laravel's Blade. 2.3k457.5k30](/packages/tightenco-jigsaw)[laravel/framework The Laravel Framework. 34.9k556.2M21.5k](/packages/laravel-framework)[illuminate/queue The Illuminate Queue package. 20433.0M1.8k](/packages/illuminate-queue)[aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 265.2k](/packages/aedart-athenaeum)[roots/acorn Framework for Roots WordPress projects built with Laravel components. 9922.4M146](/packages/roots-acorn)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 595.8M674](/packages/shopware-core) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)