Skip to content

Documentation updated for new codeblock styling options #1253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Documentation updated for new codeblock styling options #1253

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
```json
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",

Check warning on line 23 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L23 

Commas and periods go inside quotation marks.
"name": "Your Docs",

Check warning on line 24 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L24 

Commas and periods go inside quotation marks.
"colors": {
"primary": "#ff0000"
},
Expand Down Expand Up @@ -127,8 +127,26 @@
<ResponseField name="eyebrows" type="&quot;section&quot; | &quot;breadcrumbs&quot;">
The style of the page eyebrow. Choose `section` to show the section name or `breadcrumbs` to show the full navigation path. Defaults to `section`.
</ResponseField>
<ResponseField name="codeblocks" type="&quot;system&quot; | &quot;dark&quot;">
The theme of the code blocks. Choose `system` to match the site theme or `dark` for always dark code blocks. Defaults to `system`.
<ResponseField name="codeblocks" type="&quot;system&quot; | &quot;dark&quot; | object">
The theme of the code blocks. Choose `system` to match the site theme, `dark` for always dark code blocks, or specify custom themes. Defaults to `system`.

<Expandable title="Codeblocks">
<ResponseField name="theme" type="string">
A single theme to use for code blocks in both light and dark modes. Example: `"dracula"`.
</ResponseField>
<ResponseField name="themes" type="object">
Separate themes for light and dark modes.

<Expandable title="Themes">
<ResponseField name="light" type="string" required>
Theme to use in light mode.
</ResponseField>
<ResponseField name="dark" type="string" required>
Theme to use in dark mode.
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -1449,7 +1467,7 @@

</CodeGroup>

If you already have the CLI installed, make sure it is up to date:

Check warning on line 1470 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1470 

Use 'command-line tool' instead of 'CLI'.

Check warning on line 1470 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1470 

Use 'it's' instead of 'it is'.

```bash
mint update
Expand All @@ -1463,7 +1481,7 @@
mint upgrade
```

This command will create a `docs.json` file from your existing `mint.json`. Review the generated file to ensure all settings are correct.

Check warning on line 1484 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1484 

Avoid using 'will'.
</Step>
<Step title="Delete your mint.json file">
After verifying your `docs.json` is configured properly, you can safely delete your old `mint.json` file.
Expand Down