Skip to content

Commit f6dd8be

Browse files
mintlifydavidmintlifydavid
committed
added new docs to pdf page
1 parent 7f8bf7f commit f6dd8be

File tree

2 files changed

+202
-80
lines changed

2 files changed

+202
-80
lines changed

‎docs-to-pdf.mdx‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: 'Export Docs to PDF'
3+
description: 'Learn how to export your documentation to PDF format'
4+
icon: 'file-pdf'
5+
---
6+
7+
<Note>
8+
This feature is currently in closed beta and only available by invitation.
9+
</Note>
10+
11+
## Overview
12+
13+
The Docs to PDF export feature allows you to generate a comprehensive PDF version of your entire documentation. This can be useful for:
14+
15+
- Providing offline access to your documentation
16+
- Creating shareable versions for stakeholders
17+
- Archiving specific versions of your documentation
18+
- Meeting compliance or internal requirements
19+
20+
## How to Export Your Docs
21+
22+
To export your documentation to PDF:
23+
24+
1. Navigate to the **Dashboard**
25+
2. Go to **Settings**
26+
3. Select the **General** tab
27+
4. Find the **Export Content** section
28+
5. Click on **Export all content to PDF**
29+
30+
<Warning>
31+
Currently, you can only export your entire documentation. Exporting individual pages is not supported yet.
32+
</Warning>
33+
34+
<Tip>
35+
The PDF cannot be modified within Mintlify after generation. Custom styling options will be added in future updates.
36+
</Tip>
37+
38+
## Upcoming Improvements
39+
40+
We're actively working on enhancing the PDF export functionality based on user feedback. Some features we're considering include:
41+
42+
- Selective page exports
43+
- Custom PDF templates
44+
- Cover page customization
45+
- Table of contents configuration
46+
- Header and footer customization
47+
48+
## Provide Feedback
49+
50+
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.
51+
52+
<Note>
53+
Need support or want to give some feedback? You can click `support` in the **dashboard** (bottom left corner) or reach out to **[email protected]**.
54+
</Note>

‎quickstart.mdx‎

Lines changed: 148 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,165 @@
11
---
2-
title: 'Quickstart'
3-
description: 'Start building awesome documentation in under 5 minutes'
2+
title: "Quickstart"
3+
description: "Start building modern documentation in under five minutes"
4+
icon: "rocket"
45
---
56

6-
## Setup your development
7+
<Frame>
8+
<img
9+
className="block dark:hidden"
10+
src="https://mintlify-assets.b-cdn.net/hero-light.png"
11+
/>
712

8-
Learn how to update your docs locally and deploy them to the public.
13+
<img
14+
className="hidden dark:block"
15+
src="https://mintlify-assets.b-cdn.net/hero-dark.png"
16+
/>
17+
</Frame>
918

10-
### Edit and preview
19+
## Getting Started
20+
21+
Welcome\! Follow the instructions below to learn how to deploy, update and
22+
supercharge your documentation with Mintlify.
23+
24+
### Creating the Repository
25+
26+
Mintlify docs are rendered from MDX files and configurations defined in our
27+
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
28+
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.
1129

1230
<AccordionGroup>
13-
<Accordion icon="github" title="Clone your docs locally">
14-
During the onboarding process, we created a repository on your Github with
15-
your docs content. You can find this repository on our
16-
[dashboard](https://dashboard.mintlify.com). To clone the repository
17-
locally, follow these
18-
[instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
19-
in your terminal.
31+
<Accordion title="Install the GitHub app" icon="message-bot">
32+
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.
33+
34+
<Frame>
35+
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
36+
</Frame>
2037
</Accordion>
21-
<Accordion icon="rectangle-terminal" title="Preview changes">
22-
Previewing helps you make sure your changes look as intended. We built a
23-
command line interface to render these changes locally.
24-
1. Install the
25-
[Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the
26-
documentation changes locally with this command: ``` npm i -g mintlify ```
27-
2. Run the following command at the root of your documentation (where
28-
`docs.json` is): ``` mintlify dev ```
29-
<Note>
30-
If you’re currently using the legacy ```mint.json``` configuration file, please update the Mintlify CLI:
31-
32-
33-
```npm i -g mintlify@latest```
34-
And run the new upgrade command in your docs repository:
35-
36-
```mintlify upgrade```
37-
You should now be using the new ```docs.json``` configuration file. Feel free to delete the ```mint.json``` file from your repository.
38-
</Note>
38+
<Accordion title="Monorepo Setup" icon="code-branch">
39+
If you want your docs to live alongside your code as a monorepo setup, you
40+
can: 1. Move your docs content to your monorepo. 2. Specify the path to your
41+
`docs.json` in the
42+
[dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
43+
44+
<Frame>
45+
<img
46+
alt="Monorepo setup"
47+
className="block dark:hidden"
48+
src="/images/monorepo-light.png"
49+
/>
50+
51+
<img
52+
alt="Monorepo setup"
53+
className="hidden dark:block"
54+
src="/images/monorepo-dark.png"
55+
/>
56+
</Frame>
3957
</Accordion>
4058
</AccordionGroup>
4159

42-
### Deploy your changes
60+
### Updating the Content
61+
62+
Mintlify enables you to easily customize the style, structure, and content of
63+
your docs.
4364

4465
<AccordionGroup>
66+
<Accordion title="Editing locally (recommended for developers)" icon="rectangle-terminal">
67+
1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
68+
2. Once git is installed, clone your docs repository using `git clone <your-repo>`. 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).
69+
3. Use your favorite IDE to open the repository.
70+
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
4571

46-
<Accordion icon="message-bot" title="Install our Github app">
47-
Our Github app automatically deploys your changes to your docs site, so you
48-
don't need to manage deployments yourself. You can find the link to install on
49-
your [dashboard](https://dashboard.mintlify.com). Once the bot has been
50-
successfully installed, there should be a check mark next to the commit hash
51-
of the repo.
52-
</Accordion>
53-
<Accordion icon="rocket" title="Push your changes">
54-
[Commit and push your changes to
55-
Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push)
56-
for your changes to update in your docs site. If you push and don't see that
57-
the Github app successfully deployed your changes, you can also manually
58-
update your docs through our [dashboard](https://dashboard.mintlify.com).
59-
</Accordion>
72+
Learn more about this in our [local development guide](/development).
73+
</Accordion>
74+
<Accordion title="Editing with the web editor" icon="pen-to-square">
75+
Learn more about how to use the web editor on our [guide](/web-editor).
76+
</Accordion>
77+
<Accordion title="Customizing to your brand" icon="palette">
78+
Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:
79+
80+
```json
81+
"name": "Your Company"
82+
"logo": {
83+
"light": "/logo/light.svg",
84+
"dark": "/logo/dark.svg",
85+
"href": "https://yourcompany.com"
86+
},
87+
"favicon": "/favicon.svg",
88+
"colors": {
89+
"primary": "#2AB673",
90+
"light": "#55D799",
91+
"dark": "#117866",
92+
},
93+
```
94+
95+
A full list of supported configurations can be found at [global settings](/settings/global).
96+
</Accordion>
97+
<Accordion title="Adding content" icon="pencil">
98+
Add content with simple MDX files. Initiate your pages with this template:
99+
100+
```md
101+
---
102+
title: "Page Title"
103+
sidebarTitle: "Sidebar title (optional - if different from page title)"
104+
description: "Subtitle (optional)"
105+
---
106+
```
107+
108+
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
109+
</Accordion>
110+
<Accordion title="Pushing changes" icon="rocket">
111+
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).
112+
113+
<Frame>
114+
![Manual
115+
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
116+
</Frame>
117+
</Accordion>
118+
<Accordion title="Generating API references" icon="code-branch">
119+
You can easily set up your API references using an OpenAPI document.
120+
121+
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL.
122+
123+
```json
124+
"openapi": "link-to-your-openapi-file"
125+
```
60126

127+
2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
128+
129+
```bash
130+
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
131+
```
132+
133+
3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
134+
135+
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).
136+
</Accordion>
137+
<Accordion title="Adding analytics" icon="chart-simple">
138+
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).
139+
140+
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
141+
</Accordion>
61142
</AccordionGroup>
62143

63-
## Update your docs
64-
65-
Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.
66-
67-
<CardGroup>
68-
69-
<Card title="Add Content With MDX" icon="file" href="/essentials/markdown">
70-
Add content to your docs with MDX syntax.
71-
</Card>
72-
73-
<Card
74-
title="Add Code Blocks"
75-
icon="square-code"
76-
href="/essentials/code"
77-
>
78-
Add code directly to your docs with syntax highlighting.
79-
</Card>
80-
81-
<Card
82-
title="Add Images"
83-
icon="image"
84-
href="/essentials/images"
85-
>
86-
Add images to your docs to make them more engaging.
87-
</Card>
88-
89-
<Card
90-
title="Add Custom Components"
91-
icon="puzzle-piece"
92-
href="/essentials/reusable-snippets"
93-
>
94-
Add templates to your docs to make them more reusable.
95-
</Card>
96-
97-
</CardGroup>
144+
<Note>
145+
We provide a white-glove migration service as part of our Enterprise plan.
146+
Interested? You can request it by [contacting us](mailto:[email protected]).
147+
</Note>
148+
149+
### Publishing
150+
151+
<Accordion title="Adding a custom domain" icon="star">
152+
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
153+
154+
Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
155+
156+
<Frame>
157+
![Custom Domain](/images/custom-domain.png)
158+
</Frame>
159+
</Accordion>
160+
161+
Congrats, you've set up your documentation on Mintlify\!
162+
163+
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 [[email protected]](mailto:[email protected]).
164+
165+
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.

0 commit comments

Comments
 (0)