This showcase explains how to use the Embed Code application to embed code samples into Markdown or HTML documentation.
Embed Code can read any text-based source: Java, JavaScript, Python, plain text, or any other format used by your project.
The examples in this showcase use go run so they can execute directly from
the project source tree. In other projects, the intended workflow is to use a
downloaded release binary
with the same configuration shapes shown here.
- Quick start: the smallest runnable setup for a project.
- Configuration: how the CLI finds source files and documentation files.
- Embedding: how instructions select and render source content.
- Positive examples: runnable examples that should pass.
- Negative examples: intentionally broken examples that document diagnostics.