Documentation
Everything you need to write .meeko components and full-stack applications with Meeko.
Get started
- Quick start This project is dedicated to my kitten Meeko. Her face inspires the logo that accompanies it.
- Your first full-stack application This walkthrough uses the project generated by meeko init-framework. By the end, you will have a server-rendered page, a button that hydrates in the browser…
- Documentation guide The documentation is organized by task. Existing guides keep their paths and anchors to preserve links from the repository and the public website.
- Choosing in Meeko This guide connects existing capabilities. Start with your first application if you do not have a project yet, and use the reference for each API's contracts…
Framework
Components and modules
- Meeko API This page describes the component engine's public contract, exercised by the examples and tests. The stability policy specifies what SemVer covers in the 1.x…
- Meeko UI The @meekojs/ui module belongs to the Meeko ecosystem and is distributed as a package with its own version. Its installation and API are described in the Meeko…
- Meeko UI API Complete reference for @meekojs/ui. The Meeko UI guide summarizes it, and the Meeko UI site has a demo of each component.
- Internationalization This module's documentation site is published at https://i18n.meekojs.com and lives in apps/i18n. It includes guides and API documentation, with a playground…
Tools
- Project diagnostics meeko doctor inspects the local environment without executing application configuration or modules, loading .env, starting the LSP, connecting to services or…
- Editors Meeko includes a language server (Language Server Protocol) that gives any compatible editor the same features as the VS Code extension: meeko check…
- ESLint @meekojs/eslint-plugin analyzes complete .meeko components with ESLint 10 and Flat Config. It reuses Meeko's public parser for the sections and the template…
- Workspace tooling Install dependencies with pnpm install, then run pnpm build. The root configuration uses the workspace's own @meekojs/eslint-plugin and…
- Meeko DevTools DevTools lets you inspect and edit each hydrated instance during development with Vite. There are two interfaces over the same runtime: an in-page panel and a…
- Testing and distribution Run from the root with Node.js 24+ and pnpm 12.14.0:
Reference
- 1.x stability policy Starting with 1.0.0, @meekojs/meeko follows Semantic Versioning. This page defines what that promise covers, what falls outside it, how an API is removed and…
- Meeko architecture Meeko compiles .meeko files to TypeScript code with renderWithState(props) or renderToString(props) for SSR and hydrate(root, props, state?) to connect events…
- Upgrade from 1.5 to 1.6 1.6 is a minor release: new features (named route middleware, requested with middleware in definePage and +group.ts, and server route middleware…
- Upgrade from 1.6 to 1.7 1.7 is a minor release: new features (CSP and headers in server adapters, SSR page caching with cache, forms without JavaScript with form and useForm({ action…
- Upgrade from 1.7 to 1.8 1.8 is a minor release. <MeekoPopover>, <MeekoSelect> and <MeekoThemeToggle> are deprecated: they keep working in 1.x and are removed in 2.0. UI 1.8.0 provides…
- Upgrade from 1.4 to 1.5 1.5 is a minor release: new features (named layouts with +group.ts, layoutProps and useLayout(); useForm with field, trySubmit, commit, onSuccess and…
- Upgrade from 1.3 to 1.4 1.4 is a minor release: new features (light/dark theming with theme, useTheme() and <MeekoThemeToggle>, data-theme-choice, if:when on <snippet>, types named…
- Upgrade from 1.2 to 1.3 1.3 is a minor release: new features (the static adapter, site, sitemap, robots, document.seo, hash-based CSP, trustHtml, isClientError, imports.appDirs and…
- Upgrade from 1.1 to 1.2 1.2 is a minor release: new features (modules, document and useHead, <MeekoLink> and <MeekoOutlet />, zero-configuration sessions, passwords, rateLimit…
- Upgrade from 1.0 to 1.1 1.1 is a minor release: code written for 1.0 still works and new features (component tags, events, models, snippets, refs, <script server>, data composables…
- Migrate from 0.1.0 to 1.0 This guide collects breaking changes between 0.1.0 and 1.0. The full list, including additions and fixes, is in the CHANGELOG. The stability policy applies…
- Reproducible comparison: Meeko and Vue This test uses the same functional case in both engines: a server-rendered button with initial value 0, computed value doble, hydration and a click that…
- Performance From the monorepo root, with Node.js 24+ and Chrome installed:
Project
- Development roadmap Meeko 1.0 completes the scope planned for the first stable release. From there, the stability policy governs what can change in each release. This roadmap…
- Cambios de Meeko Credenciales configurables en los clientes API y RPC. ClientOptions.credentials acepta same-origin, include u omit y conserva same-origin por defecto. Permite…