Skip to content

Document dev panel page mode override #4575

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
mintlify wants to merge 1 commit into from
Closed

Document dev panel page mode override #4575

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
12 changes: 12 additions & 0 deletions installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<img
className="block dark:hidden my-0 pointer-events-none"
src="/images/installation/local-development-light.png"

Check warning on line 9 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L9 

Use 'Dev' instead of 'dev'.
alt="Decorative graphic representing the CLI."
/>
<img
Expand Down Expand Up @@ -95,6 +95,18 @@
npx mint dev
```

### Dev panel

When you run `mint dev`, a dev panel appears in the corner of your browser. The dev panel provides tools for testing your documentation without modifying any files.

Check warning on line 100 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L100 

Use 'Dev' instead of 'dev'.

Check warning on line 100 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L100 

Use 'Dev' instead of 'dev'.

#### Page mode override

Use the page mode selector in the dev panel to preview how any page looks in a different [page mode](/organize/pages#page-mode). Select from `default`, `wide`, `custom`, `center`, or `frame` to instantly switch the layout. Click **Reset** to return to the page's original mode.

This lets you experiment with page layouts before committing a `mode` change in your frontmatter.

The dev panel remembers its state (open or closed, position, and theme) across page navigations during your local preview session.

Check warning on line 108 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L108 

Use 'Dev' instead of 'dev'.

Check warning on line 108 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L108 

Did you really mean 'navigations'?

### Custom ports

By default, the CLI uses port 3000. You can customize the port using the `--port` flag. To run the CLI on port 3333, for instance, use this command:
Expand Down Expand Up @@ -245,7 +257,7 @@
```

<Note>
Only HTTPS URLs are supported in production deployments. The `--local-schema` flag is for local development only.

Check warning on line 260 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L260 

In general, use active voice instead of passive voice ('are supported').
</Note>

### Create a workflow
Expand Down
Loading