yoshida yoshida
Open the editor

Documentation

Everything about yoshida

yoshida turns a design (layers, parameters and expressions in a JSON file) and a table of card data into finished card images. One core renders everything, and three front ends use it: a command-line tool, a visual editor that runs in the browser, and a small server.

This documentation covers version 0.8.0 of the tool and version 1 of the file format.

Looking for the old Python version? It lives on as 0.3.1-python.

Start here

Make my first card

See what yoshida can do

Install it, or host it for a team

Use the visual editor

Write a design by hand

Render from a script or CI

Fix an error message

Let an AI agent write designs

Browse the docs

Start

Your first card, what yoshida can do, the examples, and how to run it.

Getting Started Your first card in five minutes: in the editor, from scratch and on the command line.
Installation Run yoshida in the browser, from the release zip, with Docker or from source.
Feature Tour What a design can do, one short snippet per feature, with links to the details.
Usage Statistics Optional anonymous counts, kept only on the server that hosts the editor.
Examples The four example projects, what each one shows and how to open them.
Command Line Check projects, render cards and format files from a terminal or CI.
Server and Docker Host the editor and render whole card sets on your own server.

Format

The project files by hand: designs, params, layers, expressions and card data.

Project Layout and Manifest A project folder, its paths and the yoshida.json manifest.
Designs A design file: canvas, fonts, params and the layers that are drawn.
Params The inputs a card can set: types, defaults, lists and enums.
Layers How layers are drawn, and the fields every layer type shares.
Repeat Draw a layer once per item, for example a row of stars or one line per list item.
Extends Start a layer from another layer and change only what differs.
Effects Crop, fade, sharpen, blur and shadow effects applied to a layer's own pixels.
Card Data The table of values that fills a design, as JSON or CSV.
Rendering Model How a card becomes pixels, step by step.
Diagnostics How problems are reported, and every error code with its fix.
Formatting and Schemas How every tool writes JSON, and the JSON Schemas for editors.
Limits and Versioning Size limits, how to raise them and how the format is versioned.

Builder

The visual editor in your browser, panel by panel.

Overview The visual editor that runs in your browser, and how its panels fit together.
Canvas The live card preview: selecting, moving, resizing and rotating layers.
Layers The layer tree: reorder, group, hide and lock layers.
Inspector Every field of the selected layer, with multi-select editing.
Fonts Find, preview, import and assign fonts, with their licenses.
Params Add and edit the params a card can set, in groups.
Card data Edit the cards of a set as a form or a table, in JSON or CSV.
Files The project's files as a folder tree: add, rename, move and delete.
Problems Every error, warning and hint in one panel, with jump-to-source.
Expression editor Suggestions, signatures, hover info, formatting and the formula window for expression fields.
Shortcuts Keyboard shortcuts for the editor.
Saving, Images and Privacy Where the editor keeps your work, and what leaves your machine.

Contribute

Build yoshida yourself and learn how the pieces fit together.

Contributing How to report, propose and send changes: setup, checks, PR titles, labels and releases.
Building from Source Build the CLI, the server, the WASM core and the editor yourself.
Testing The test suites, what each one covers and how to run a single one.
CI and Deployment The GitHub Actions workflows for checks, releases and this website.
Architecture One I/O-free core, three front ends, and how they fit together.
WASM Interface How the editor talks to the WASM core.
Server API The HTTP API of yoshida-server.
Known Gaps What does not work yet.
Third-Party Notices Licences of the fonts and libraries yoshida ships with.

↑↓ to moveEnter to openEsc to close