# Inkkit

> Inkkit is a Markdown editor for web pages and for apps that host a web view. It edits formatted text and saves Markdown as it was written.

> ## Agent Instructions
> Import only `@aicayzer/inkkit`, `@aicayzer/inkkit/core` and `@aicayzer/inkkit/style.css`. Never import Milkdown or ProseMirror, and never rely on Inkkit's internal classes or markup.
> Pass the current generation to every call that takes one. Handle failures by `InkKitError.code`, not by message.
> Save only the text of a `snapshot()` call that succeeded. A failed snapshot is not an unchanged document.

- [Inkkit](https://inkkit.cyzr.me/index.md): A Markdown editor for web pages and for apps that host a web view.
- [Quickstart](https://inkkit.cyzr.me/quickstart.md): Mount an editor and connect it to your app’s storage.
- [Compatibility](https://inkkit.cyzr.me/compatibility.md): Browser requirements, package entries, page size and versioning.
- [Documents and saving](https://inkkit.cyzr.me/concepts/documents.md): Load the right document, save a current snapshot, and handle failures without losing text.
- [Preservation](https://inkkit.cyzr.me/concepts/preservation.md): What stays unchanged, what an edit can rewrite, and how preservation failures are handled.
- [Markdown support](https://inkkit.cyzr.me/concepts/markdown.md): Which Markdown Inkkit renders and edits, which it keeps as literal source, what needs an adapter, and the rules for each construct.
- [Copy, paste and print](https://inkkit.cyzr.me/concepts/clipboard.md): What Inkkit puts on the clipboard, how it imports pasted web pages, spreadsheets and text, which links it keeps, and how to print a document.
- [Embed in a web view](https://inkkit.cyzr.me/guides/web-view.md): Bundle Inkkit into one offline page, load it in WKWebView, and connect native code through a JavaScript shim.
- [Images, files and wiki links](https://inkkit.cyzr.me/guides/adapters.md): Connect your storage to Inkkit with image, file and wiki-link adapters, and keep bytes, display URLs and cleanup in your app.
- [Toolbars, shortcuts and search](https://inkkit.cyzr.me/guides/controls.md): Drive your own toolbar, shortcuts, slash menu, find bar and outline from Inkkit commands and state.
- [Appearance and labels](https://inkkit.cyzr.me/guides/appearance.md): Match your app’s typography, colors and language.
- [Editor](https://inkkit.cyzr.me/reference/editor.md): Every InkKitEditor member: signature, result, the state it checks and the errors it reports, grouped by task.
- [Options and events](https://inkkit.cyzr.me/reference/options.md): Every mount option and event handler, the command state that drives toolbars, format and table commands, text input preferences and the slash menu.
- [Adapters](https://inkkit.cyzr.me/reference/adapters.md): The exact contract of ImageAdapter, FileAdapter and WikiLinkAdapter: when Inkkit calls each member, what it passes, and what a result or failure does.
- [Errors](https://inkkit.cyzr.me/reference/errors.md): Every InkKitError code, what it means and what your app should do, where errors arrive, and the warnings that degraded output carries.
- [Tokens, labels and shortcuts](https://inkkit.cyzr.me/reference/appearance.md): Every --inkkit-* CSS token with its default, every label with its default text, and every shortcut name with its default keys.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.