Skip to content
alkemist

Names and public types

A recognizable Alk prefix without long authoring names.

Use Alk for public components and exported custom types:

Sourcets
AlkLayout;
AlkChart;
AlkModel;
AlkFigure;
AlkChartProps;
AlkAssetManifest;
AlkWidgetState;

AlkLayout, AlkChart, AlkModel, AlkMath, AlkCode, and the fixed-study AlkShader are implemented. Their prop types use the same prefix. AlkFigure, AlkAssetManifest, and AlkWidgetState above remain proposed names.

The prefix makes Alkemist components easy for people and AI assistants to identify, avoids collisions with a site’s own Chart or Model, and keeps examples consistent.

Package names stay @alkemist/*. The integration function is alkemist(), and CSS tokens use --alk-*. Internal variables do not need the prefix.

Local aliases

Authors can explicitly alias a component in their own files. Canonical documentation and generated examples use Alk*; aliases do not create a second public API to maintain.

Sourceastro
---
import Layout from '@alkemist/ui/AlkLayout.astro';
---

<Layout title="My notebook"><slot /></Layout>