Guide
Welcome to the Clarity theme guide. This theme is designed for AI products, focusing on minimalism, readability, and elegance.
"Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away." — Antoine de Saint-Exupéry
Features
- Soft gradient backgrounds: A subtle radial gradient that adds depth without distraction.
- Minimalist UI: Clean borders, transparent backgrounds, and blurred navigation.
- Lots of whitespace: Large padding and margins to let the content breathe.
- Card-based information blocks: Bento grid layout for organizing complex information.
- Editorial typography: Playfair Display for headings, Inter for body text.
Callouts
Callouts are styled with soft backgrounds, rounded corners, and elegant typography.
Use the tip callout to highlight best practices or recommended approaches.
The info callout is perfect for general notes or additional context.
Use the warning callout when users need to be careful about a specific action.
The danger callout should be reserved for destructive or irreversible actions.
Tabs & Steps
Install the package
First, install the package using your preferred package manager.
Configure the theme
Update your rspress.config.ts to use the new theme.
Start the dev server
Run npm run dev to see your changes locally.
Badges
You can use badges to highlight specific terms or versions:
- New Added support for dark mode.
- Beta Try the new AI search feature.
- Deprecated The old API will be removed in v2.0.
- Error Failed to connect to the server.
Blockquotes
Blockquotes are styled with a large serif font to give them an editorial feel.
"Good design is making something intelligible and memorable. Great design is making something memorable and meaningful."
— Dieter Rams
Tables
Tables have been redesigned to be clean, borderless (vertically), and spacious.
Code Example
Here is an example of how code blocks look in this theme, complete with a title and syntax highlighting. For more details, check out the Rspress Documentation.
Bento Grid Layout
You can use the bento grid layout in your markdown files by using the bento-grid and bento-card classes:
Design
Focus on content with a distraction-free layout.
Performance
Lightning fast page loads with Rsbuild.