Skip to content

Commit 53bbd12

Browse files
committed
Update theme docs
1 parent 673daaf commit 53bbd12

File tree

3 files changed

+13
-22
lines changed

3 files changed

+13
-22
lines changed

core-concepts/themes.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ icon: "paint-bucket"
66

77
import { ThemeCard } from "/snippets/theme-card.mdx";
88

9-
We offer pre-built themes so you can differentiate the look and feel of your documentation based on your brand.
9+
The platform supports a variety of pre-built themes so you can tailor the look and feel of your documentation based on your brand.
1010

1111
## Configuration
1212

13-
You can configure the theme in the `docs.json` file.
13+
You can configure the theme property in [docs.json](/core-concepts/settings#param-theme).
1414

15-
For example, to use the `maple` theme, you can add the following to your `docs.json` file:
15+
For example, to use the `maple` theme, you can add the following:
1616

1717
```json
1818
{
1919
"theme": "maple"
2020
}
2121
```
2222

23-
## Available Themes
23+
## Themes
2424

2525
There are a variety of themes to choose from.
2626

image-embeds.mdx

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,11 @@ icon: 'image'
99
src="https://mintlify-assets.b-cdn.net/bigbend.jpg"
1010
/>
1111

12-
<Info>
13-
Mintlify supports files up to 5 MB. To use larger files, consider a storage
14-
service like Cloudinary and embed in your documentation using the URL.
15-
</Info>
16-
1712
## Image
1813

19-
### Using Markdown
14+
Images are the most common way to add visual content to your documentation.
15+
16+
### Basics
2017

2118
The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code
2219

@@ -26,9 +23,10 @@ The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets y
2623
<Tip>
2724
To make sure images are displayed correctly in production, add a forward slash to the image path (e.g. `/path/image.jpg`).
2825
</Tip>
29-
Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed.
3026

31-
### Using Embeds
27+
Note that the image file size must be less than 20MB. Otherwise, we recommend hosting on a CDN provider like [S3](https://aws.amazon.com/s3), [Cloudinary](https://cloudinary.com) or a similar service.
28+
29+
### Embeds
3230

3331
To get more customizability with images, you can also use embeds to add images.
3432

@@ -144,8 +142,3 @@ Loads another HTML page within the document.
144142
<iframe src="https://www.youtube.com/embed/4KzFe50RQkQ"> </iframe>
145143
```
146144

147-
<Tip>
148-
Although not required, we recommend adding the `alt` and `title` attributes to
149-
images for better SEO and accessability. Learn more at [image
150-
SEO](https://yoast.com/image-seo-alt-tag-and-title-tag-optimization/).
151-
</Tip>

text.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,9 @@ Best used for subsection headers.
2020
### Subtitles
2121
```
2222

23-
<Tip>
24-
25-
Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right.
26-
27-
</Tip>
23+
<Info>
24+
Titles and subtitles create anchors and also show up on the table of contents on the right.
25+
</Info>
2826

2927
## Text Formatting
3028

0 commit comments

Comments
 (0)