diff --git a/docs-to-pdf.mdx b/docs-to-pdf.mdx new file mode 100644 index 00000000..e0d058bd --- /dev/null +++ b/docs-to-pdf.mdx @@ -0,0 +1,54 @@ +--- +title: 'Export Docs to PDF' +description: 'Learn how to export your documentation to PDF format' +icon: 'file-pdf' +--- + + + This feature is currently in closed beta and only available by invitation. + + +## Overview + +The Docs to PDF export feature allows you to generate a comprehensive PDF version of your entire documentation. This can be useful for: + +- Providing offline access to your documentation +- Creating shareable versions for stakeholders +- Archiving specific versions of your documentation +- Meeting compliance or internal requirements + +## How to Export Your Docs + +To export your documentation to PDF: + +1. Navigate to the **Dashboard** +2. Go to **Settings** +3. Select the **General** tab +4. Find the **Export Content** section +5. Click on **Export all content to PDF** + + + Currently, you can only export your entire documentation. Exporting individual pages is not supported yet. + + + + The PDF cannot be modified within Mintlify after generation. Custom styling options will be added in future updates. + + +## Upcoming Improvements + +We're actively working on enhancing the PDF export functionality based on user feedback. Some features we're considering include: + +- Selective page exports +- Custom PDF templates +- Cover page customization +- Table of contents configuration +- Header and footer customization + +## Provide Feedback + +We're continuously improving this feature based on customer feedback. We'd love to hear about your use cases and what functionality you'd like to see in future updates. + + + Need support or want to give some feedback? You can click `support` in the **dashboard** (bottom left corner) or reach out to **support@mintlify.com**. + diff --git a/docs.json b/docs.json index 37bf183d..453c9448 100644 --- a/docs.json +++ b/docs.json @@ -25,7 +25,8 @@ "essentials/images", "essentials/settings", "essentials/navigation", - "essentials/reusable-snippets" + "essentials/reusable-snippets", + "docs-to-pdf" ] } ] diff --git a/quickstart.mdx b/quickstart.mdx index 9ac2a6ac..adcc439a 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,97 +1,165 @@ --- -title: 'Quickstart' -description: 'Start building awesome documentation in under 5 minutes' +title: "Quickstart" +description: "Start building modern documentation in under five minutes" +icon: "rocket" --- -## Setup your development + + -Learn how to update your docs locally and deploy them to the public. + + -### Edit and preview +## Getting Started + +Welcome\! Follow the instructions below to learn how to deploy, update and +supercharge your documentation with Mintlify. + +### Creating the Repository + +Mintlify docs are rendered from MDX files and configurations defined in our +[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate +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. - - During the onboarding process, we created a repository on your Github with - your docs content. You can find this repository on our - [dashboard](https://dashboard.mintlify.com). To clone the repository - locally, follow these - [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) - in your terminal. + + 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) + - - Previewing helps you make sure your changes look as intended. We built a - command line interface to render these changes locally. - 1. Install the - [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the - documentation changes locally with this command: ``` npm i -g mintlify ``` - 2. Run the following command at the root of your documentation (where - `docs.json` is): ``` mintlify dev ``` - - If you’re currently using the legacy ```mint.json``` configuration file, please update the Mintlify CLI: - - - ```npm i -g mintlify@latest``` - And run the new upgrade command in your docs repository: - - ```mintlify upgrade``` - You should now be using the new ```docs.json``` configuration file. Feel free to delete the ```mint.json``` file from your repository. - + + 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 + [dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings) + + + Monorepo setup + + Monorepo setup + -### Deploy your changes +### Updating the Content + +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. + 4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`. - - Our Github app automatically deploys your changes to your docs site, so you - don't need to manage deployments yourself. You can find the link to install on - your [dashboard](https://dashboard.mintlify.com). Once the bot has been - successfully installed, there should be a check mark next to the commit hash - of the repo. - - - [Commit and push your changes to - Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) - for your changes to update in your docs site. If you push and don't see that - the Github app successfully deployed your changes, you can also manually - update your docs through our [dashboard](https://dashboard.mintlify.com). - + 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 + "name": "Your Company" + "logo": { + "light": "/logo/light.svg", + "dark": "/logo/dark.svg", + "href": "https://yourcompany.com" + }, + "favicon": "/favicon.svg", + "colors": { + "primary": "#2AB673", + "light": "#55D799", + "dark": "#117866", + }, + ``` + + 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 + --- + title: "Page Title" + sidebarTitle: "Sidebar title (optional - if different from page title)" + description: "Subtitle (optional)" + --- + ``` + + 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). + + + ![Manual +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. + + ```json + "openapi": "link-to-your-openapi-file" + ``` + 2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as: + + ```bash + npx @mintlify/scraping@latest openapi-file + ``` + + 3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`. + + 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). + -## Update your docs - -Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own. - - - - - Add content to your docs with MDX syntax. - - - - Add code directly to your docs with syntax highlighting. - - - - Add images to your docs to make them more engaging. - - - - Add templates to your docs to make them more reusable. - - - + + We provide a white-glove migration service as part of our Enterprise plan. + Interested? You can request it by [contacting us](mailto:sales@mintlify.com). + + +### 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. + + + ![Custom Domain](/images/custom-domain.png) + + + +Congrats, you've set up your documentation on Mintlify\! + +Need support or want to give some feedback? You can click `support` in the [dashboard](http://dashboard.mintlify.com) (bottom left corner) or reach out to [support@mintlify.com](mailto:support@mintlify.com). + +You can also join our [community](https://mintlify.com/community) to engage with other Mintlify users and stay up to date with the latest feature drops. \ No newline at end of file