diff --git a/docs.json b/docs.json index f42331020..522989241 100644 --- a/docs.json +++ b/docs.json @@ -14,13 +14,14 @@ "navigation": { "dropdowns": [ { - "dropdown": "Getting Started", - "icon": "layers", + "dropdown": "Documentation", + "icon": "book", "description": "Set up your documentation", "groups": [ { "group": "Getting Started", "pages": [ + "introduction", "quickstart", { "group": "Editing", diff --git a/images/hero/background-dark.png b/images/hero/background-dark.png new file mode 100644 index 000000000..4be83712c Binary files /dev/null and b/images/hero/background-dark.png differ diff --git a/images/hero/background-light.png b/images/hero/background-light.png new file mode 100644 index 000000000..b0b072a85 Binary files /dev/null and b/images/hero/background-light.png differ diff --git a/images/hero/cli-dark.png b/images/hero/cli-dark.png new file mode 100644 index 000000000..00bbcffd9 Binary files /dev/null and b/images/hero/cli-dark.png differ diff --git a/images/hero/cli.png b/images/hero/cli.png new file mode 100644 index 000000000..a4ca24be4 Binary files /dev/null and b/images/hero/cli.png differ diff --git a/images/hero/components-dark.png b/images/hero/components-dark.png new file mode 100644 index 000000000..9097f44af Binary files /dev/null and b/images/hero/components-dark.png differ diff --git a/images/hero/components.png b/images/hero/components.png new file mode 100644 index 000000000..4fd34decf Binary files /dev/null and b/images/hero/components.png differ diff --git a/images/hero/editor-dark.png b/images/hero/editor-dark.png new file mode 100644 index 000000000..e877b2ba0 Binary files /dev/null and b/images/hero/editor-dark.png differ diff --git a/images/hero/editor.png b/images/hero/editor.png new file mode 100644 index 000000000..48f788185 Binary files /dev/null and b/images/hero/editor.png differ diff --git a/images/hero/rocket-dark.png b/images/hero/rocket-dark.png new file mode 100644 index 000000000..539fb15d6 Binary files /dev/null and b/images/hero/rocket-dark.png differ diff --git a/images/hero/rocket.png b/images/hero/rocket.png new file mode 100644 index 000000000..29cd1bff5 Binary files /dev/null and b/images/hero/rocket.png differ diff --git a/introduction.mdx b/introduction.mdx new file mode 100644 index 000000000..20d8ca32d --- /dev/null +++ b/introduction.mdx @@ -0,0 +1,45 @@ +--- +title: "Introduction" +description: "Start building modern documentation in under five minutes" +icon: "book-open" +mode: "custom" +--- + +export const HeroCard = ({ filename, title, description, href }) => { + return ( + + + +

{title}

+

+ {description} +

+ + ) +} + +
+ +
+ + +
+ +
+

+ Documentation +

+ +

+ Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers. +

+ +
+ + + + +
+
+ +
\ No newline at end of file diff --git a/quickstart.mdx b/quickstart.mdx index adcc439a8..ad15120b0 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,21 +1,9 @@ --- title: "Quickstart" -description: "Start building modern documentation in under five minutes" +description: "Build your documentation in minutes" icon: "rocket" --- - - - - - - ## Getting Started Welcome\! Follow the instructions below to learn how to deploy, update and @@ -28,14 +16,14 @@ Mintlify docs are rendered from MDX files and configurations defined in our your docs with your code, and make source control effortless. Onboard through the [dashboard](https://dashboard.mintlify.com) or clone our [starter kit](https://github.com/mintlify/starter) to get started. - + Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository. ![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png) - + If you want your docs to live alongside your code as a monorepo setup, you can: 1. Move your docs content to your monorepo. 2. Specify the path to your `docs.json` in the @@ -63,7 +51,7 @@ Mintlify enables you to easily customize the style, structure, and content of your docs. - + 1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). 2. Once git is installed, clone your docs repository using `git clone `. If you haven't set it up yet, now would be a good time to do so with these [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). 3. Use your favorite IDE to open the repository. @@ -71,10 +59,10 @@ your docs. Learn more about this in our [local development guide](/development). - + Learn more about how to use the web editor on our [guide](/web-editor). - + Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations: ```json @@ -94,7 +82,7 @@ your docs. A full list of supported configurations can be found at [global settings](/settings/global). - + Add content with simple MDX files. Initiate your pages with this template: ```md @@ -107,7 +95,7 @@ your docs. Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components). - + Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com). @@ -115,7 +103,7 @@ your docs. Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png) - + You can easily set up your API references using an OpenAPI document. 1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL. @@ -134,7 +122,7 @@ Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-updat For a complete guide on using Mintlify with OpenAPI, check out [this guide](/api-playground/openapi/setup). [This guide](/api-playground/openapi/writing-openapi) explains how to configure your API authentication methods. For manual API references definition, explore [our syntax](/api-playground/overview). - + Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics). We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview). @@ -148,7 +136,7 @@ Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-updat ### Publishing - + Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan. Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.