Document your design system with dynamic blocks
Text can be edited the same as in any most other editing software programs. There are multiple types of styles that text blocks can have for different purposes.
Text blocks are created by simply typing in a new row in the documentation editor.
Example:
This is regular text.
This is bold text.
This is italic text.
This is strikethrough text.
Create hierarchy with headers.
Display information in bulleted or ordered lists.
Display a quotation.
Divide sections of content.
A callout block can be used to highlight a section of text to make it stand out, and to communicate a certain message in your documentation.
There are four styles of a callout block (info, success, warning, error). Hover and click the icon to select a specific style for your block.
An inline link can be used to add links to text in your documentation.
In Supernova, you can easily link to another page in the documentation. In the case that a page gets moved or renamed, the link will stay valid.
A code block can be created to display a code snippet.
Live example:
alert("Hello, World!");
Plain text can also be formatted as inline code with the rich text editing bar.
Highlight the text and click the code icon button to convert it to an inline code block.
This is inline code
A tab block can be created to create tabbed sections of rich content. Tab blocks can contain other blocks (except for other tab blocks or tables).
Compelling, rich documentation sells design systems inside organizations, but requires a lot of effort to get off the ground. Supernova makes creation and ongoing maintenance dead easy so you can focus on improving your design system.
Supernova manages the entire design system lifecycle in one place, without making your team change tools or maintain self-built workflows and integrations. Automate everything to fit the way you work already.
An image in a tab block
A table block can be used to display text or images in a simple table format.
How text blocks are styled in the published documentation is determined by the documentation exporter.
See Custom properties for more details.
Custom properties