Skip to content

Commit eaee076

Browse files
committed
Add themes page
1 parent 8f8c3c3 commit eaee076

File tree

7 files changed

+54
-0
lines changed

7 files changed

+54
-0
lines changed

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
"navigation/localization"
3737
]
3838
},
39+
"themes",
3940
"migration"
4041
]
4142
},

images/themes/maple.png

666 KB
Loading

images/themes/mint.png

691 KB
Loading

images/themes/palm.png

690 KB
Loading

images/themes/willow.png

665 KB
Loading

snippets/theme-card.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
export const ThemeCard = ({ title, description, image, href }) => {
2+
return (
3+
<div className="flex mt-4 gap-12 group">
4+
<div className="flex-1">
5+
<h4 className="mt-0">{title}</h4>
6+
<div class="prose-sm prose-gray mb-4">{description}</div>
7+
<a href={href} className="not-prose text-sm font-medium text-gray-500 hover:text-gray-700 dark:hover:text-gray-300">
8+
See preview
9+
</a>
10+
</div>
11+
<div className="flex-1">
12+
<a href={href}>
13+
<img className="mt-0 rounded-xl" src={image} alt={title} style={{ pointerEvents: 'none' }} />
14+
</a>
15+
</div>
16+
</div>
17+
);
18+
};

themes.mdx

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: "Themes"
3+
icon: "palette"
4+
description: "Customize the appearance of your documentation"
5+
---
6+
7+
import { ThemeCard } from "/snippets/theme-card.mdx";
8+
9+
We offer pre-built themes so you can differentiate the look and feel of your documentation based on your brand.
10+
11+
## Configuration
12+
13+
You can configure the theme in the `docs.json` file.
14+
15+
For example, to use the `maple` theme, you can add the following to your `docs.json` file:
16+
17+
```json
18+
{
19+
"theme": "maple"
20+
}
21+
```
22+
23+
## Available Themes
24+
25+
There are a variety of themes to choose from.
26+
27+
<br />
28+
29+
<ThemeCard title="Mint" description="Classic documentation theme with time-tested layouts and familiar navigation." image="/images/themes/mint.png" href="https://mint.mintlify.app" />
30+
31+
<ThemeCard title="Maple" description="Modern, clean aesthetics perfect for AI and SaaS products." image="/images/themes/maple.png" href="https://maple.mintlify.app" />
32+
33+
<ThemeCard title="Palm" description="Sophisticated fintech theme with deep customization for enterprise documentation." image="/images/themes/palm.png" href="https://palm.mintlify.app" />
34+
35+
<ThemeCard title="Willow" description="Stripped-back essentials for distraction-free documentation." image="/images/themes/willow.png" href="https://willow.mintlify.app" />

0 commit comments

Comments
 (0)