-
Notifications
You must be signed in to change notification settings - Fork 220
Transform docs to banana theme #3107
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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." | ||||||
| description: "Meet the next generation of documentation. Banana-powered, beautifully yellow, and built for developers who love potassium." | ||||||
| mode: "frame" | ||||||
| keywords: ["overview", "platform", "getting started", "features"] | ||||||
| keywords: ["overview", "platform", "getting started", "features", "bananas"] | ||||||
| --- | ||||||
|
|
||||||
| export const HeroCard = ({ filename, title, description, href }) => { | ||||||
|
|
@@ -21,8 +21,8 @@ | |||||
| </h3> | ||||||
| <span className="mt-1.5">{description}</span> | ||||||
| </a> | ||||||
| ); | ||||||
| }; | ||||||
|
|
||||||
| <div className="relative"> | ||||||
| <div className="absolute -top-14 left-0 right-0 opacity-80"> | ||||||
|
|
@@ -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 | ||||||
| 🍌 Bananafication 🍌 | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid emoji in the main heading; it tends to look noisy in tabs/search results and can read unprofessional.
Suggested change
|
||||||
| </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. | ||||||
| Meet the next generation of documentation. Banana-powered, potassium-rich, and built for developers who appreciate the appeal of yellow fruit. | ||||||
| </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="🍌 Quickstart" description="Peel your first banana docs site in minutes with our step-by-step guide" href="/quickstart" /> | ||||||
|
|
||||||
| <HeroCard | ||||||
| filename="cli" | ||||||
| title="CLI installation" | ||||||
| description="Install the CLI to preview and develop your docs locally" | ||||||
| title="🍌 CLI installation" | ||||||
| description="Install the Banana CLI to preview and develop your docs locally" | ||||||
| href="/installation" | ||||||
| /> | ||||||
|
|
||||||
| <HeroCard | ||||||
| filename="editor" | ||||||
| title="Web editor" | ||||||
| description="Make quick updates and manage content with our browser-based editor" | ||||||
| title="🍌 Web editor" | ||||||
| description="Make quick banana updates and manage content with our browser-based editor" | ||||||
| href="/editor/index" | ||||||
| /> | ||||||
|
|
||||||
| <HeroCard | ||||||
| filename="components" | ||||||
| title="Components" | ||||||
| description="Build rich, interactive documentation with our ready-to-use components" | ||||||
| title="🍌 Components" | ||||||
| description="Build rich, interactive banana documentation with our ready-to-use components" | ||||||
| href="/components/accordions" | ||||||
| /> | ||||||
| </div> | ||||||
|
|
||||||
| 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 banana docs locally, test changes in real-time, and catch issues before deploying your banana documentation site." | ||||||
| keywords: ["CLI", "npm", "local development", "Node.js", "banana"] | ||||||
| --- | ||||||
|
|
||||||
| <img | ||||||
|
|
@@ -15,13 +15,13 @@ | |||||
| 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 banana 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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Since the link points to the
Suggested change
|
||||||
|
|
||||||
| 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 banana formats. | ||||||
|
|
||||||
| ## Prerequisites | ||||||
|
|
||||||
| - [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 | ||||||
|
|
||||||
|
|
@@ -31,7 +31,7 @@ | |||||
| <Step title="Locate your 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) | ||||||
| - `mintlify-community/docs-{org-name}-{id}` (Bananify-hosted repository) | ||||||
| - `your-org/your-repo` (your own GitHub repository) | ||||||
| </Step> | ||||||
|
|
||||||
|
|
@@ -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. | ||||||
|
|
||||||
| ### Find accessibility issues | ||||||
|
|
||||||
|
|
@@ -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
|
||||||
|
|
||||||
| **Solution:** Ask your IT administrator to whitelist `releases.mintlify.com` to enable local development with the CLI. | ||||||
| </Accordion> | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,53 +1,53 @@ | ||||||
| --- | ||||||
| title: "Quickstart" | ||||||
| description: "Deploy your documentation site and make your first change." | ||||||
| keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"] | ||||||
| description: "Peel and deploy your banana documentation site and make your first change." | ||||||
| keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding", "banana"] | ||||||
| --- | ||||||
|
|
||||||
| 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 live banana-themed documentation site ready to customize and update with potassium-rich content. | ||||||
|
|
||||||
| ## Before you begin | ||||||
|
|
||||||
| 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 banana 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>. | ||||||
|
|
||||||
| 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 banana documentation repository to your Bananify deployment, you can work on your documentation locally or in the web editor and sync any changes to your remote repository. | ||||||
|
|
||||||
| ## 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 onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your banana 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 onboarding, your banana documentation site is deployed and accessible at your `.mintlify.app` URL. | ||||||
|
|
||||||
| <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. | ||||||
| If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during onboarding. Bananify creates a private repository in a private organization and automatically configures the GitHub App for you. | ||||||
|
|
||||||
| This lets you use the web editor immediately and migrate to your own repository later. | ||||||
| </Accordion> | ||||||
| </AccordionGroup> | ||||||
|
|
||||||
| ## View your deployed site | ||||||
| ## View your deployed 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`. | ||||||
|
|
||||||
| Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). | ||||||
|
|
||||||
| <Frame> | ||||||
| <img | ||||||
| src="/images/quickstart/mintlify-domain-light.png" | ||||||
| alt="Overview page of the Mintlify dashboard." | ||||||
| alt="Overview page of the Bananify dashboard." | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Alt text should match what the screenshot shows (and the URL still says
Suggested change
|
||||||
| className="block dark:hidden" | ||||||
| /> | ||||||
|
|
||||||
| <img | ||||||
| src="/images/quickstart/mintlify-domain-dark.png" | ||||||
| alt="Overview page of the Mintlify dashboard." | ||||||
| alt="Overview page of the Bananify dashboard." | ||||||
| className="hidden dark:block" | ||||||
| /> | ||||||
| </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 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). | ||||||
| </Tip> | ||||||
|
|
||||||
| ## Make your first change | ||||||
|
|
@@ -56,7 +56,7 @@ | |||||
| <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. | ||||||
|
|
||||||
| <CodeGroup> | ||||||
|
|
||||||
|
|
@@ -104,7 +104,7 @@ | |||||
| 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. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. | ||||||
| </Step> | ||||||
| </Steps> | ||||||
| </Tab> | ||||||
|
|
@@ -138,7 +138,7 @@ | |||||
| ## Next 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> | ||||||
| <Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands"> | ||||||
| Find broken links, check accessibility, validate OpenAPI specs, and more. | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The schema/tools here are still Mintlify (
docs.jsonuseshttps://mintlify.com/docs.json), so calling it the "Bananify schema" seems misleading.