Guidelark docs
1. Reading your library
Open Guidelark in your library file and pick what to document: the whole file, this page or the selection (components, component sets, or a section or frame that holds them). Selecting one variant documents its whole set.
- Components and component sets become pages. Their names give the navigation:
Forms/Buttonis the page "Button" in the group "Forms". - Names starting with
.or_and variables hidden from publishing are left out unless you tick "Include hidden items". - The Library tab lists what it found. Select jumps to a component on the canvas.
2. What goes on a component page
| On the page | From Figma |
|---|---|
| Introduction | The component description, with bold, italics, lists, inline code and links. Links in it must start with https://, http:// or mailto:. |
| Links | The documentation links on the component (Figma's "Add link" in the properties panel) |
| Preview | A picture of the default variant (the first one in the set) |
| Usage | Do, Don't and Caution frames (see below) |
| Properties | Every component property: variant, boolean, text, instance swap and slot, with its default, options and description |
| Variants | Tables with a picture of every variant. The first variant property runs down the side, the second across the top, and there's a table for each value of the rest (up to 16 tables). Combinations that don't exist are empty cells. |
| Specs | The default variant's size, auto layout direction, padding and gap, corner radius, and every variable and style it uses (with the layer and what it's used for) |
| Notes | Dev Mode annotations on the component and its default variant, with their category and the values they pin |
3. Do and Don't examples
Name a frame, section or group Do, Don't, Caution or Avoid, with an optional caption after a colon: Do: Use one primary button per view. Without a caption, the first short text inside the frame is used. Guidelark links each one to a component:
- by name:
Button / Don't: Stack two primary buttonsgoes to Button, wherever it is; - otherwise by place: it goes to the nearest component in the same section or frame.
Frames it can't link are listed under "Before you export" on the Library tab.
4. Tokens and styles
Each variable collection gets a page with every mode as a column, so Light and Dark (or brands, or densities) sit side by side. Colours get swatches, spacing and size numbers get bars, radii get a rounded corner, and aliases show the variable they point to under the resolved value. The CSS column uses the variable's web code syntax when you set one (var(--acme-primary)), otherwise a name made from its path.
Every export also includes, in data/:
tokens.css: custom properties, each collection's default mode on:rootand the others under a data attribute, for example[data-theme="dark"];tokens/*.tokens.json: W3C design tokens (format 2025.10), one file per collection and mode, aliases as{color.blue.500};library.json: everything Guidelark read, for your own templates.
Variables from another library show by name, since their values live in that library's file.
5. Formats
| Format | What you get |
|---|---|
| Static website | index.html, a page per component, collection, styles and the changelog, pictures in img/, search, light and dark themes. Relative links: open it from a folder, or upload it to GitHub Pages, Netlify, Cloudflare Pages, S3 or any web server. Set the title, introduction and accent colour on the Export tab. |
| Docusaurus | MDX pages with front matter and _category_.json sidebars. Put the folder inside your docs/ directory; index.mdx becomes the category's page. |
| Storybook | MDX docs pages with <Meta title> under the sidebar folder you choose, pictures imported so your builder bundles them. Pick Storybook 9 or later, or 8. |
| Markdown | Plain GitHub-flavoured Markdown with pictures, README.md as the overview and CHANGELOG.md. Colour swatches are small SVG files, because GitHub strips inline styles. |
Pictures render at 2x by default. Turn off "A picture of every variant" or choose 1x for big libraries: pictures are the slow part of an export.
6. Versions and the changelog
Each export compares the library with the last export from this file and picks the next version:
- Major (breaking): a component, property, token or style removed or renamed, a property's type changed, or fewer variants;
- Minor: something added;
- Patch: values, defaults, specs, descriptions, examples or notes changed, or a component looks different.
The first export is 1.0.0. An export with no changes keeps the version. The Changes tab shows the list before you export. The history is saved in the Figma file, so whoever exports next continues the same changelog.
7. GitHub pull requests
Choose "GitHub pull request" on the Export tab and enter the repository (owner/name), the base branch (empty means the default branch) and the folder, for example docs/design-system. Then make a fine-grained personal access token at github.com/settings/personal-access-tokens/new for that repository with Contents and Pull requests set to Read and write, paste it and click Save token.
Each export makes a branch like docs/1.2.0-20261007-1500, commits the docs and opens a pull request with the change list. Files in the folder that the export no longer writes (a deleted component's page) are deleted in the same commit. At the repository root only files Guidelark writes are touched. The token stays in Figma's storage on your computer and goes only to api.github.com.
8. Trial and plans
The trial gives you 10 exports over 7 days, starting with your first export, up to 25 components each (document a page or a selection to stay under it). A ZIP or a pull request is one export. Reading the library, the gap list and the change list are always free. Then $59 a month or $590 a year per person who exports; readers need nothing. Enter your license key under Plans and license key.
9. Limits
- Up to 1,500 components, 64 variant pictures per component, 3,000 pictures and 6,000 variables per export.
- Pictures are capped at 4,000 px on the long side.
- Guidelark doesn't host docs, offer a web editor or write guidance. It publishes what's in Figma.
Questions: hello@greatwork.company. A person replies within one business day.