Skip to content

Commit 79efbdc

Browse files
IHStenIHSten
committed
test hidden page in preview on prod
1 parent 3ccba78 commit 79efbdc

File tree

1 file changed

+186
-0
lines changed

1 file changed

+186
-0
lines changed

‎spooky.mdx‎

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
---
2+
title: "Spooky Hidden Page ooooooo"
3+
description: "This page is hidden, it's not in navigation ooooooo"
4+
icon: "ghost"
5+
---
6+
7+
<Frame>
8+
<img
9+
className="block dark:hidden"
10+
src="https://mintlify-assets.b-cdn.net/hero-light.png"
11+
/>
12+
<img
13+
className="hidden dark:block"
14+
src="https://mintlify-assets.b-cdn.net/hero-dark.png"
15+
/>
16+
</Frame>
17+
18+
## Getting Started
19+
20+
Welcome! Follow the instructions below to learn how to deploy, update and
21+
supercharge your documentation with Mintlify.
22+
23+
### Creating the Repository
24+
25+
Mintlify docs are rendered from MDX files and configurations defined in our
26+
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
27+
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.
28+
29+
<AccordionGroup>
30+
31+
<Accordion icon="message-bot" title="Install the GitHub app">
32+
33+
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.
34+
35+
<Frame>
36+
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
37+
</Frame>
38+
39+
</Accordion>
40+
41+
<Accordion icon="code-branch" title="Monorepo Setup">
42+
If you want your docs to live alongside your code as a monorepo setup, you
43+
can: 1. Move your docs content to your monorepo. 2. Specify the path to your
44+
`docs.json` in the
45+
[dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
46+
<Frame>
47+
<img
48+
alt="Monorepo setup"
49+
className="block dark:hidden"
50+
src="/images/monorepo-light.png"
51+
/>
52+
<img
53+
alt="Monorepo setup"
54+
className="hidden dark:block"
55+
src="/images/monorepo-dark.png"
56+
/>
57+
</Frame>
58+
</Accordion>
59+
60+
</AccordionGroup>
61+
62+
### Updating the Content
63+
64+
Mintlify enables you to easily customize the style, structure, and content of
65+
your docs.
66+
67+
<AccordionGroup>
68+
<Accordion icon="rectangle-terminal" title="Editing locally (recommended for developers)">
69+
70+
1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
71+
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).
72+
3. Use your favorite IDE to open the repository.
73+
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.
74+
75+
Learn more about this in our [local development guide](/development).
76+
77+
</Accordion>
78+
79+
<Accordion icon="pen-to-square" title="Editing with the web editor">
80+
81+
Learn more about how to use the web editor on our [guide](/web-editor).
82+
83+
</Accordion>
84+
85+
<Accordion icon="palette" title="Customizing to your brand">
86+
87+
Easily customize colors, logos and buttons among other configurations in our `docs.json` file. Start with these basic configurations:
88+
89+
```json
90+
"name": "Your Company"
91+
"logo": {
92+
"light": "/logo/light.svg",
93+
"dark": "/logo/dark.svg",
94+
"href": "https://yourcompany.com"
95+
},
96+
"favicon": "/favicon.svg",
97+
"colors": {
98+
"primary": "#2AB673",
99+
"light": "#55D799",
100+
"dark": "#117866",
101+
},
102+
```
103+
104+
A full list of supported configurations can be found at [global settings](/settings/global).
105+
106+
</Accordion>
107+
108+
<Accordion icon="pencil" title="Adding content">
109+
110+
Add content with simple MDX files. Initiate your pages with this template:
111+
112+
```md
113+
---
114+
title: "Page Title"
115+
sidebarTitle: "Sidebar title (optional - if different from page title)"
116+
description: "Subtitle (optional)"
117+
---
118+
```
119+
120+
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).
121+
122+
</Accordion>
123+
124+
<Accordion icon="rocket" title="Pushing changes">
125+
126+
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).
127+
128+
<Frame>
129+
![Manual
130+
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
131+
</Frame>
132+
133+
</Accordion>
134+
135+
<Accordion icon="code-branch" title="Generating API references">
136+
137+
You can easily set up your API references using an OpenAPI document.
138+
139+
1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `docs.json` with a URL.
140+
141+
```json
142+
"openapi": "link-to-your-openapi-file"
143+
```
144+
145+
2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:
146+
147+
```bash
148+
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
149+
```
150+
151+
3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.
152+
153+
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).
154+
155+
</Accordion>
156+
157+
<Accordion icon="chart-simple" title="Adding analytics">
158+
159+
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).
160+
161+
We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).
162+
163+
</Accordion>
164+
</AccordionGroup>
165+
166+
<Note>
167+
We provide a white-glove migration service as part of our Enterprise plan.
168+
Interested? You can request it by [contacting us](mailto:[email protected]).
169+
</Note>
170+
171+
### Publishing
172+
173+
<Accordion icon="star" title="Adding a custom domain">
174+
175+
Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.
176+
177+
Navigate to your [dashboard settings](https://dashboard.mintlify.com/settings) to add a custom domain.
178+
179+
<Frame>![Custom Domain](/images/custom-domain.png)</Frame>
180+
181+
</Accordion>
182+
183+
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
184+
support or want to give some feedback? You can join our
185+
[community](https://mintlify.com/community) or drop us an email at
186+
[[email protected]](mailto:[email protected]).

0 commit comments

Comments
 (0)