Deleted non used pages
This commit is contained in:
D-K-P
@@ -1,49 +0,0 @@
|
||||
---
|
||||
title: "Development"
|
||||
description: "Install the Mintlify CLI to preview changes locally"
|
||||
---
|
||||
|
||||
<Tabs>
|
||||
<Tab title="npm">
|
||||
Using the [npm](https://www.npmjs.com) package manager
|
||||
|
||||
```bash
|
||||
npm i -g mintlify
|
||||
```
|
||||
</Tab>
|
||||
<Tab title="yarn">
|
||||
Using the [yarn](https://yarnpkg.com) package manager
|
||||
|
||||
```bash
|
||||
yarn global add mintlify
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Previewing Changes Locally
|
||||
|
||||
Run the following command at the root of your documentation where `mint.json` is located. Mintlify will open at `localhost:3000`.
|
||||
|
||||
```bash Terminal
|
||||
mintlify dev
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Here's how to solve some common problems when working with the CLI.
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Mintlify is not loading">
|
||||
Update to Node v18 and the latest version of Git.
|
||||
</Accordion>
|
||||
<Accordion
|
||||
title="Mintlify is not loading after updating Node and Git"
|
||||
>
|
||||
Run `mintlify install` and try again.
|
||||
</Accordion>
|
||||
<Accordion
|
||||
title="Port 3000 is already taken"
|
||||
>
|
||||
The Mintlify CLI will automatically move to the next port if you were already running something at `localhost:3000`. For example, if you were running two documentation sites, they would be at `localhost:3000` and `localhost:3001`.
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
@@ -1,32 +0,0 @@
|
||||
---
|
||||
title: "Features"
|
||||
description: "Upgrades you can expect from the platform"
|
||||
---
|
||||
|
||||
## Optimized to Convert Users
|
||||
|
||||
Everything is heavily optimized for SEO and conversion
|
||||
|
||||
|
||||
|
||||
## High-performing Search
|
||||
|
||||
Ultra-fast search comes out of the box and re-indexes all of the documentation on every update
|
||||
|
||||
|
||||
|
||||
## Interactive API Playground
|
||||
|
||||
Interactive API Playground pages for users to explore the endpoints
|
||||
|
||||
|
||||
|
||||
## Light and Dark Mode
|
||||
|
||||
Check out light and dark mode offered out of the box and beautiful for every bit of content and components
|
||||
|
||||
|
||||
|
||||
## Analytics Built to Understand Users
|
||||
|
||||
Analytics is built into the platform to help you understand what page users are interacting with, where they are converting, and where they are dropping off
|
||||
@@ -1,83 +0,0 @@
|
||||
---
|
||||
title: "Automate complex workflows with code"
|
||||
sidebarTitle: "Introduction"
|
||||
description: "Trigger workflows from APIs, on a schedule, or on demand. API calls are easy with authentication handled for you. Add durable delays that survive server restarts."
|
||||
---
|
||||
|
||||
<Note>
|
||||
Welcome to the Mintlify starter kit. Update the content in main branch of your
|
||||
docs repo, and your documentation page will automatically be updated. It's
|
||||
that simple!
|
||||
</Note>
|
||||
|
||||
## Getting Started
|
||||
|
||||
Select from the following guides to learn more about how Mintlify can best suit your documentation.
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Development" icon="rectangle-terminal" href="/development">
|
||||
Run on your computer to see changes locally
|
||||
</Card>
|
||||
<Card
|
||||
title="Global Settings"
|
||||
icon="sliders"
|
||||
href="https://mintlify.com/docs/settings/global"
|
||||
>
|
||||
Customizing the theme, branding, and other global configurations
|
||||
</Card>
|
||||
<Card
|
||||
title="Page Titles and Metadata"
|
||||
icon="heading"
|
||||
href="https://mintlify.com/docs/settings/page"
|
||||
>
|
||||
Setting the title and metadata for navigation and SEO
|
||||
</Card>
|
||||
<Card
|
||||
title="Writing Content"
|
||||
icon="pen-nib"
|
||||
href="https://mintlify.com/docs/components/overview"
|
||||
>
|
||||
Introduction on how to add and edit content
|
||||
</Card>
|
||||
<Card title="Learn More" icon="ellipsis" href="/resources">
|
||||
See more in the resources page
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Customization Checklist
|
||||
|
||||
Learn more about you can fully customize the starter template for your own documentation
|
||||
|
||||
<AccordionGroup>
|
||||
<Accordion title="Change name">Update the `name` property in `mint.json` to the name of your company or product</Accordion>
|
||||
<Accordion title="Customize the branding">
|
||||
Branding mostly happens in the `mint.json` file. You can learn more about all available [configuration properties](https://mintlify.com/docs/settings/global).
|
||||
|
||||
#### Update the logo
|
||||
|
||||
Update `logo` folder with the light and dark version of your logo (can be svg or png).
|
||||
<Note>Make sure that the path matches the values set in `logo` of `mint.json`</Note>
|
||||
|
||||
#### Customize the colors
|
||||
|
||||
Populate the `colors` object with colors that match your brand
|
||||
|
||||
#### Update the favicon
|
||||
|
||||
Change the `favicon.png` with an image of the favicon
|
||||
|
||||
#### Update footer social icons
|
||||
|
||||
Update `footerSocials` with the right `[platform]: [url]` key-value pair
|
||||
|
||||
</Accordion>
|
||||
<Accordion title="Update the anchors">Update the `anchors` array in `mint.json` with the links that you want to emphasize</Accordion>
|
||||
<Accordion title="Update or remove the API Reference">
|
||||
Either update the pages in `api-reference` or remove it entirely
|
||||
<Note>If removing the API Reference, make sure to also remove it from the `anchors` and `navigation` from `mint.json`</Note>
|
||||
</Accordion>
|
||||
<Accordion title="Update the topbar navigation items">
|
||||
Update the `topbarCtaButton` and `topbarLinks` properties in `mint.json` to the links that matter most
|
||||
<Tip>The `topbarCtaButton` will receive the most number of clicks</Tip>
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
Reference in New Issue
Block a user