Reference
This reference lists the features of Kitten. Each page covers one topic.
For a comprehensive āownerās manualā-style technical reference of how Kitten is designed and works internally, please see the Technical Manual.
Getting started
What Kitten is and how to get up and running with it.
Glossary
Terms used in Kitten and the documentation.
JavaScript and TypeScript
Available languages and type safety.
HTML
Kittenās progressively-enhanced HTML tagged templates and Streaming HTML workflow.
Components
Components and event handling.
Markdown
Kittenās enhanced Markdown support.
- Markdown pages (.page.md files).
- Markdown fragments
- Markdown in Kitten HTML tagged template strings
- Heading links
- Syntax highlighting
Icons
Finding, using, and extending Kittenās icon components.
Client-side libraries
Libraries Kitten serves by default (htmx, Alpine.js, Water, crypto, etc.)
File types
Kittenās naming convention-based file system routing.
HTTP routes
GET, POST, and other HTTP routes, authorisation, and the request and response helpers.
Route parameters
Named, optional, and wildcard parameters, and route order matching.
WebSocket routes
Socket routes and the default page socket on live pages.
URLs and redirects
URL normalisation, reserved Kitten routes, redirects, the Evergreen Web, and archives.
Database
Kittenās built-in JavaScript database (JSDB), and other data scopes.
Sessions and authentication
Sessions, signing in, and authenticated routes.
Uploads
Receiving files, upload limits, and serving uploaded files privately and publicly.
App modules
A way to organise and share code between routes, and strongly type your databases.
Command-line interface
CLI commands for launching the Kitten server and much more besides.
- Default command
- Project commands
- Database commands
- Deployment of Kitten applications
- Kitten daemon (systemd service) commands
- General commands
Interactive shell
A REPL for inspecting and modifying the state of a running Kitten app.
Logs
Sectioned logs, and the lifecycle and event logs.
Deployment
Deploy your app with automatic updates, webhooks, and versioning.
Troubleshooting
Known problems and solutions.
The kitten global
Properties of the global kitten object, and the introspection API.
Cryptography
The cryptography API, its cryptographic properties, and the threat model.
Working on Kitten
Building, debugging, profiling, testing, and releasing Kitten itself.
Questions?
Contact Aral on the fediverse.