Documentation
Welcome to the Sarmal documentation. Here you'll find everything you need to get started, from installation to advanced customization.
Sarmal /sɑːrˈmɑːl/ From the Turkish word for spiral. To define a path traced by a point moving through space.
The word is built from the verb sarmak (to wrap, to coil) with
the suffix
-al, which forms nouns for the result of an action. So sarmal is literally 'that which is coiled'
Getting Started
New to Sarmal? Start with the Getting Started guide to install
@sarmal/core and render your first animation in minutes.
Explore
- Concepts Understand curves, the skeleton, and the engine.
- Getting Started Install @sarmal/core and animate your first curve.
- API Reference Complete reference for all public methods, options, and the curve definition schema.
- Canvas vs SVG Choose the right renderer for your use case.
- Dot Matrix Renderer Render sarmal curves as a grid of fading dots. Blueprint aesthetic, configurable density, smooth gradients.
- Curve Catalog Browse available curves and their parameters.
Can't find what you're looking for? Check the Playground to experiment live, or visit the GitHub repository for the source code.