Documentation 101

A quick guide for documenting your design system with Supernova.

null

Document your design system with our powerful editor, and integrate your Supernova design system data to keep your documentation effortlessly up to date.

In our editor, you can collaboratively write and maintain your documentation, customize the appearance of your documentation site, and manage your content workflow, so that information is shared when it's ready (and when you're ready).

Our editor uses a series of flexible 'blocks' that allow you to add content quickly and easily, and open up endless opportunity to effectively share your documentation with your team — or even the wider world.

Documentation features

Our documentation editor includes:

  • rich text editing, code blocks, and images
  • add static images from Figma frames
  • add special blocks created from your design system data, such as:
    • individual tokens, token lists and groups
    • individual components, component lists and groups
    • component sandbox
  • custom URL embeds, including Figma frames, Storybook and YouTube
  • add custom shortcuts to other sections of your documentation

 

Learn about creating documentation in Supernova