⭐ Found this useful? Install from Packagist · Give it a star on GitHub so more developers can find it.
Manual Kit Bundle — an in-app product manual for Symfony built from your docs/manual Markdown: one source that
GitHub renders as it is and the application serves inside its own layout, translated per locale with stable anchors,
admin-only chapters and blocks that fail closed, figures with a lightbox, search tags and an optional
SearchKit provider.
📋 Compatible with Symfony 7.4+ and 8.0–8.1+ — PHP 8.4+.
This bundle is FrankenPHP worker mode friendly. See docs/FRANKENPHP-WORKER-AUDIT.md.
- One source for GitHub and the app:
docs/manual/*.mdin reading order frommanifest.yaml; links between chapters (02-dashboard.md#filters) become in-app routes, links to other repository docs open the published copy (docs_url), GitHub-style.mdURLs redirect to the chapter - Translations per locale:
docs/manual/es/02-dashboard.mdnext to the source; a chapter without a translation is served from the source with a not translated yet notice;<!-- translation-of: <hash> -->marks a translation outdated as soon as its source changes - Stable anchors:
<a id="filters"></a>gives a heading the same id in every language, so the application's links (manual_href('manual/02-dashboard.md#filters')) survive translated titles - Audiences that fail closed:
audience: adminchapters answer 404 to members (no existence oracle);<!-- audience: admin -->blocks are dropped for members,audience: githubblocks never show in the app, and an unclosed or misspelt marker hides the rest of the chapter - Figures: images become figures with their title as caption, intrinsic width / height, lazy loading, phone screenshots sized down, several images of one paragraph side by side, and an opt-in Stimulus lightbox
- Sub-pages (1.6):
parent: <slug>nests chapters up to three levels (/manual/guide/install/docker, files in sub-folders, translations alongside); folded branches in the chapter list, breadcrumb, depth-first pager, inherited access that can only narrow, search results as "Parent › Child" - Chapter redirects (1.11):
old-slug: new-slugand'old-slug#anchor': 'new-slug#anchor'in config or aredirects:file of the manifest;/manual/<old-slug>answers 301 in the reader's locale (after the target's access check: no existence oracle), a small CSP-safe script maps the moved anchors,nowo:manual:redirectslints the map - Desktop / phone views (1.12, opt-in):
<!-- device: phone -->/<!-- device: desktop -->blocks (both show on GitHub), an accessible CSP-safe Desktop / Phone switch on chapters that have them (viewport default, choice kept per reader, no reload), automatic phone screenshots (x.webp→x.phone.webp), search hits that open their view - Search:
tagsin the manifest and<!-- tags: … -->under a heading feed the SearchKit "Manual" group (chapters and sections the viewer may read, in their locale) - Translation checks for CI:
nowo:manual:check --strictfails on outdated translations and missing stable anchors;nowo:manual:stamp es 02-dashboardrecords that a translation matches its source again - Sanitised and cached: CommonMark + GFM through the Symfony HTML sanitiser, cached per chapter, audience, locale and file version; images served with a sandboxing CSP
- Overridable templates and CSS custom properties (
--nowo-manual-*); 7 locales (en, es, de, fr, it, nl, pt)
composer require nowo-tech/manual-kit-bundle// config/bundles.php
return [
Nowo\ManualKitBundle\NowoManualKitBundle::class => ['all' => true],
];- Import the routes and publish the stylesheet (
bin/console assets:install):
# config/routes/nowo_manual_kit.yaml
nowo_manual_kit:
resource: '@NowoManualKitBundle/Resources/config/routes.php'
prefix: /manual
trailing_slash_on_root: false # the home is /manual, not /manual/- Write the manual (the defaults read
docs/manual):
# docs/manual/manifest.yaml
chapters:
- { slug: README }
- { slug: 01-getting-started, group: using, tags: [start, onboarding] }
- { slug: 02-administration, group: administration, audience: admin }<!-- docs/manual/01-getting-started.md -->
# Getting started
<a id="first-steps"></a>
## First steps
<!-- tags: sign in, login -->
- Frame it in your layout and link to it:
# config/packages/nowo_manual_kit.yaml
nowo_manual_kit:
layout: 'base.html.twig' # blocks: title, stylesheets, body
docs_url: 'https://github.com/acme/app/blob/main/docs/'<a href="{{ manual_href('manual/01-getting-started.md#first-steps') }}">Help</a>Full guide: docs/INSTALLATION.md · options: docs/CONFIGURATION.md · writing and translating the manual, templates, lightbox, search, commands: docs/USAGE.md.
- PHP
>=8.4 <8.6 - Symfony 7.4, 8.0, and 8.1+
- FrameworkBundle, TwigBundle, SecurityBundle (security-core), Asset, HtmlSanitizer, Yaml,
league/commonmark^2.6 - Optional:
nowo-tech/search-kit-bundle^1.1 (Manual group in the header search),@hotwired/stimulusin the application for the figure lightbox peer (orstandalone_lightbox: true, a self-contained script)
| Version | PHP | Symfony | Status |
|---|---|---|---|
| 1.x | 8.4 – 8.5 | 7.4, 8.0, 8.1+ | Supported (bug and security fixes) |
A Symfony 8.1 demo runs on FrankenPHP (worker mode by default); it needs no database:
make -C demo up
# Demo started at: http://localhost:8177Sign in as demo / demo (member) or admin / admin, open Manual, zoom the figure and switch to Español.
See demo/README.md and docs/DEMO-FRANKENPHP.md.
Playwright end-to-end tests: make -C demo/symfony8 test-e2e (see docs/CONTRIBUTING.md).
- Installation
- Configuration
- Usage
- Contributing
- Code of Conduct
- Changelog
- Upgrading
- Release
- Security
- Engram
- Spec-driven development
- GitHub Spec Kit
- Templates
- Architecture
- PSR evaluation
- Coverage policy
- Demo FrankenPHP
- FrankenPHP worker audit
- GitHub CI
- GitHub About
- Tests: PHPUnit (unit, integration, functional), Vitest (the Stimulus peer and the standalone lightbox), Playwright (demo e2e)
- PHP: 100%
- TS/JS: 100%
- Python: N/A
PHP line coverage: 100% of includable src/ (gate 100%). TypeScript: Vitest thresholds 100% statements /
branches / functions / lines on src/Resources/assets (make gate ≥ 90%).
make test
make test-coverage
make test-ts
make qaMIT © 2026 Héctor Franco Aceituno / Nowo.tech


