Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "almond",
"name": "Mintlify",
"name": "Bananify",
"colors": {
"primary": "#166E3F",
"light": "#26BD6C",
"dark": "#166E3F"
"primary": "#FFD700",
"light": "#FFF900",
"dark": "#B8860B"
},
"favicon": "/favicon.ico",
"icons": {
Expand Down
24 changes: 12 additions & 12 deletions index.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Introduction"
description: "Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers."
title: "Welcome to the Banana Grove"
description: "Meet the sweetest documentation platform. Peel back the layers of complex docs with our a-peel-ing, banana-themed experience."
mode: "frame"
keywords: ["overview", "platform", "getting started", "features"]
keywords: ["banana", "fruity docs", "getting started", "yellow features"]
---

export const HeroCard = ({ filename, title, description, href }) => {
Expand All @@ -21,8 +21,8 @@
</h3>
<span className="mt-1.5">{description}</span>
</a>
);

Check warning on line 24 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L24

Use semicolons judiciously.
};

Check warning on line 25 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L25

Use semicolons judiciously.

<div className="relative">
<div className="absolute -top-14 left-0 right-0 opacity-80">
Expand All @@ -40,34 +40,34 @@

<div className="relative z-10 px-4 py-16 lg:py-48 lg:pb-24 max-w-3xl mx-auto">
<h1 className="block text-4xl font-medium text-center text-gray-900 dark:text-zinc-50 tracking-tight">
Documentation
🍌 Banana Documentation 🍌
</h1>

<div className="max-w-xl mx-auto px-4 mt-4 text-lg text-center text-gray-500 dark:text-zinc-500">
Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers and teams.
Welcome to the ripest documentation experience! Our banana-themed platform makes creating docs a-peel-ing and fun. Split from boring docs and go bananas with our fruity features.
</div>

<div className="px-6 lg:px-0 mt-12 lg:mt-24 grid sm:grid-cols-2 gap-x-6 gap-y-4">
<HeroCard filename="rocket" title="Quickstart" description="Deploy your first docs site in minutes with our step-by-step guide" href="/quickstart" />
<HeroCard filename="rocket" title="🍌 Peel & Start" description="Deploy your first banana docs site in minutes - no monkeying around!" href="/quickstart" />

<HeroCard
filename="cli"
title="CLI installation"
description="Install the CLI to preview and develop your docs locally"
title="🍌 Banana CLI"
description="Install our a-peel-ing CLI to preview and develop your fruity docs locally"
href="/installation"
/>

<HeroCard
filename="editor"
title="Web editor"
description="Make quick updates and manage content with our browser-based editor"
title="🍌 Banana Editor"
description="Make sweet updates and manage content with our bunch-tastic browser editor"
href="/editor/index"
/>

<HeroCard
filename="components"
title="Components"
description="Build rich, interactive documentation with our ready-to-use components"
title="🍌 Banana Components"
description="Build rich, interactive documentation with our ripe-and-ready components"
href="/components/accordions"
/>
</div>
Expand Down
34 changes: 17 additions & 17 deletions installation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Install the CLI"
description: "Use the CLI to preview docs locally, test changes in real-time, and catch issues before deploying your documentation site."
keywords: ["CLI", "npm", "local development", "Node.js"]
title: "🍌 Install the Banana CLI"
description: "Use the Banana CLI to preview your fruity docs locally, test changes in real-time, and catch issues before deploying - it's bananas how useful it is!"

Check warning on line 3 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L3

Don't use exclamation points in text.
keywords: ["Banana CLI", "npm", "local development", "Node.js", "fruity tools"]
---

<img
Expand All @@ -15,38 +15,38 @@
alt="Decorative graphic representing the CLI."
/>

Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and functionality, and catch issues like broken links or accessibility problems.
Use the [Banana CLI](https://www.npmjs.com/package/mint) to preview your fruity documentation locally as you write and edit. View changes in real-time before deploying, test your banana documentation site's appearance and functionality, and catch issues like broken links or accessibility problems - no rotten code allowed!

Check warning on line 18 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L18

Use 'capability' or 'feature' instead of 'functionality'.

Check warning on line 18 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L18

Don't use exclamation points in text.

The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats.
The Banana CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats. It's the top banana for doc maintenance!

Check warning on line 20 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L20

Don't use exclamation points in text.

## Prerequisites
## Prerequisites (don't go bananas without these!)

- [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed
- [Git](https://git-scm.com/downloads) installed
- Your documentation repository cloned locally
- [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed - make sure it's ripe!

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Spell out 'LTS', if it's unfamiliar to the audience.

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Don't use exclamation points in text.
- [Git](https://git-scm.com/downloads) installed - for version control that's bananas good
- Your banana documentation repository cloned locally

### Clone your repository
### Clone your banana repository

<Steps>
<Step title="Locate your repository">
<Step title="🍌 Locate your banana repository">
1. Go to the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard.
2. Note your repository location. It is one of these formats:
- `mintlify-community/docs-{org-name}-{id}` (Mintlify-hosted repository)
- `your-org/your-repo` (your own GitHub repository)
- `mintlify-community/docs-{org-name}-{id}` (Bananify-hosted repository - hosted in the banana grove!)
- `your-org/your-repo` (your own GitHub repository - your personal banana plantation!)
</Step>

<Step title="Clone your repository">
<Step title="🍌 Clone your banana repository">
<Tabs>
<Tab title="Your own repository">
Replace `your-org/your-repo` with your actual repository details from [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings).
<Tab title="Your own banana plantation">
Replace `your-org/your-repo` with your actual repository details from [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) - time to harvest your docs!

Check warning on line 41 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L41

Don't use exclamation points in text.

```bash
git clone https://github.com/your-org/your-repo
cd your-repo
```

<Tip>
**GitHub App required.** To enable automatic deployments when you push changes, you must install the GitHub app. See [GitHub](/deploy/github) for more information.
**🍌 GitHub App required.** To enable automatic deployments when you push changes, you must install the GitHub app - it's bananas useful! See [GitHub](/deploy/github) for more information.
</Tip>

</Tab>
Expand Down Expand Up @@ -181,7 +181,7 @@
mint broken-links
```

The command ignores files matching [.mintignore](/organize/mintignore) patterns. Links that point to ignored files are reported as broken.

Check warning on line 184 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L184

In general, use active voice instead of passive voice ('are reported').

### Find accessibility issues

Expand Down Expand Up @@ -294,7 +294,7 @@
```
</Accordion>
<Accordion title="Client version shows 'none' after installation">
If you run `mint version` and the client version displays as `none`, the CLI may be unable to download the client application due to a corporate firewall or VPN blocking the download.

Check warning on line 297 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L297

Use 'app' instead of 'application'.

Check warning on line 297 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L297

Spell out 'VPN', if it's unfamiliar to the audience.

**Solution:** Ask your IT administrator to whitelist `releases.mintlify.com` to enable local development with the CLI.
</Accordion>
Expand Down
100 changes: 50 additions & 50 deletions quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
---
title: "Quickstart"
description: "Deploy your documentation site and make your first change."
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
title: "🍌 Banana Quick-peel"
description: "Deploy your banana-themed docs site and make your first a-peel-ing change!"

Check warning on line 3 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L3

Don't use exclamation points in text.
keywords: ["banana quickstart", "deploy", "go bananas", "first peel", "banana tutorial", "setup", "banana boarding"]
---

After you complete this guide, you'll have a live documentation site ready to customize and update.
After you complete this guide, you'll have a ripe, live banana documentation site ready to customize and make even more a-peel-ing!

Check warning on line 7 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L7

Don't use exclamation points in text.

## Before you begin
## Before you go bananas

Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>.
Bananify uses a docs-as-code approach to manage your fruity documentation. Every page on your site has a corresponding file stored in your banana documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your banana repository to access and modify content, or you can edit files locally in your preferred IDE - no monkeying around!">repository</Tooltip>.

Check warning on line 11 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L11

Did you really mean 'Bananify'?

When you connect your documentation repository to your Mintlify deployment, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.
When you connect your documentation repository to your Bananify deployment, you can work on your banana docs locally or in the web editor and sync any changes to your remote repository. It's bananas how easy it is!

Check warning on line 13 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L13

Did you really mean 'Bananify'?

Check warning on line 13 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L13

Don't use exclamation points in text.

## Deploy your documentation site
## Deploy your banana documentation site

Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.
Go to [mintlify.com/start](https://mintlify.com/start) and complete the banana-boarding process. During banana-boarding, you'll connect your GitHub account, create or select a repository for your fruity documentation, and install the GitHub App to enable automatic deployments.

After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.
After banana-boarding, your documentation site is deployed and accessible at your `.mintlify.app` URL - ripe and ready to go!

Check warning on line 19 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L19

In general, use active voice instead of passive voice ('is deployed').

Check warning on line 19 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L19

Don't use exclamation points in text.

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you.
<Accordion title="🍌 Optional: Skip connecting GitHub during banana-boarding">
If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during banana-boarding. Bananify creates a private repository in a private organization and automatically configures the GitHub App for you - no split decisions needed!

Check warning on line 23 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L23

Did you really mean 'Bananify'?

Check warning on line 23 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L23

Don't use exclamation points in text.

This lets you use the web editor immediately and migrate to your own repository later.
This lets you use the web editor immediately and migrate to your own repository later when you're ready to go full banana.
</Accordion>
</AccordionGroup>

## View your deployed site
## View your ripe banana site

Your documentation site is now deployed at `https://<your-project-name>.mintlify.app`.
Your banana documentation site is now deployed at `https://<your-project-name>.mintlify.app` - sweet!

Check warning on line 31 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L31

Don't use exclamation points in text.

Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).
Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/) - it's the top banana!

Check warning on line 33 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L33

Don't use exclamation points in text.

<Frame>
<img
Expand All @@ -47,16 +47,16 @@
</Frame>

<Tip>
Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain).
Your banana site is ripe and ready to view immediately! Use this URL for testing and sharing with your bunch. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain) to make it even more a-peel-ing.

Check warning on line 50 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L50

Don't use exclamation points in text.
</Tip>

## Make your first change
## Make your first a-peel-ing change

<Tabs>
<Tab title="CLI">
<Steps>
<Step title="Install the CLI">
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.
<Step title="🍌 Install the Banana CLI">
The Banana CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability - no rotten versions!

Check warning on line 59 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L59

Spell out 'LTS', if it's unfamiliar to the audience.

Check warning on line 59 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L59

Don't use exclamation points in text.

<CodeGroup>

Expand All @@ -71,78 +71,78 @@

</CodeGroup>

See [Install the CLI](/installation) for full details and troubleshooting.
See [Install the Banana CLI](/installation) for full details and troubleshooting - we'll help you split any problems!
</Step>
<Step title="Clone your repository">
If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository).
<Step title="🍌 Clone your banana repository">
If you haven't already cloned your repository locally, follow the instructions in [Clone your banana repository](/installation#clone-your-repository) - don't let it slip away!
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broken internal link due to renamed heading anchor

Medium Severity

The link [Clone your banana repository](/installation#clone-your-repository) in quickstart.mdx points to an anchor that no longer exists. The heading in installation.mdx was renamed from "Clone your repository" to "Clone your banana repository", changing the anchor to #clone-your-banana-repository. The link URL needs to match the new anchor, or an explicit id attribute needs to be added to preserve the old anchor.

Additional Locations (1)

Fix in Cursor Fix in Web

</Step>
<Step title="Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter:
<Step title="🍌 Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter to something more a-peel-ing:

```mdx
---
title: "Introduction"
description: "Your custom description here"
title: "Welcome to the Banana Grove"
description: "Your custom banana description here - make it sweet!"
---
```
</Step>
<Step title="Preview locally">
Run the following command from your documentation directory:
<Step title="🍌 Preview your banana docs locally">
Run the following command from your banana documentation directory:

```bash
mint dev
```

View your preview at `http://localhost:3000`.
View your sweet preview at `http://localhost:3000` - it's bananas how good it looks!
</Step>
<Step title="Push your changes">
<Step title="🍌 Push your banana changes">
Commit and push your changes to trigger a deployment:

```bash
git add .
git commit -m "Update description"
git commit -m "Add banana flavor to description"
git push
```

Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard.
Bananify automatically deploys your changes - it's bananas how fast it is! View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard.
</Step>
</Steps>
</Tab>
<Tab title="Web editor">
<Steps>
<Step title="Open the web editor">
Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
<Step title="🍌 Open the banana web editor">
Navigate to the [banana web editor](https://dashboard.mintlify.com/editor) in your dashboard - time to go bananas with editing!

Check warning on line 114 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L114

Don't use exclamation points in text.
</Step>
<Step title="Edit a page">
Open the **Introduction** page and update the description.
<Step title="🍌 Edit a page">
Open the **Welcome to the Banana Grove** page and update the description to make it more a-peel-ing.

<Frame>
<img src="/images/quickstart/hello-world-light.png" alt="Introduction page open in the web editor with the description edited to say Hello world!."
<img src="/images/quickstart/hello-world-light.png" alt="Banana Grove page open in the web editor with the description edited to say Hello banana world!."
className="block dark:hidden"
/>
<img src="/images/quickstart/hello-world-dark.png" alt="Introduction page open in the web editor with the description edited to say Hello world!."
<img src="/images/quickstart/hello-world-dark.png" alt="Banana Grove page open in the web editor with the description edited to say Hello banana world!."
className="hidden dark:block"
/>
</Frame>
</Step>
<Step title="Publish">
Click the **Publish** button in the top-right of the web editor toolbar.
<Step title="🍌 Publish your banana goodness">
Click the **Publish** button in the top-right of the web editor toolbar - let's make these changes ripe for the world!
</Step>
<Step title="View live">
On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live.
<Step title="🍌 View your banana site live">
On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your banana site's deployment status. When it finishes deploying, refresh your documentation site to see your sweet changes live - it's bananas!
</Step>
</Steps>
</Tab>
</Tabs>

## Next steps
## Next banana steps

<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
Edit documentation in your browser and preview how your pages will look when published.
<Card title="🍌 Use the banana web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
Edit your fruity documentation in your browser and preview how your pages will look when published - it's bananas how easy it is!

Check warning on line 141 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L141

Avoid using 'will'.
</Card>
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
Find broken links, check accessibility, validate OpenAPI specs, and more.
<Card title="🍌 Explore banana CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
Find broken links, check accessibility, validate OpenAPI specs, and more - no monkeying around with quality!
</Card>
<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
Use your own domain for your documentation site.
<Card title="🍌 Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
Use your own domain for your banana documentation site - make it the top banana!

Check warning on line 147 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L147

Don't use exclamation points in text.
</Card>
Loading