-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
68f4bb5
commit 11713ce
Showing
4 changed files
with
24 additions
and
159 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,11 +15,14 @@ icon: "rocket" | |
|
||
## Getting Started | ||
|
||
Welcome to the Mintlify documentation guide. Follow the instructions below to learn how to deploy, update and supercharge your documentation with Mintlify. | ||
Welcome to the Mintlify documentation guide. Follow the instructions below to | ||
learn how to deploy, update and supercharge your documentation with Mintlify. | ||
|
||
### 1. Deploying Your Docs Repository | ||
|
||
Mintlify docs are rendered from MDX files and configurations defined in our [starter template](https://github.com/mintlify/starter). We use Github to integrate your docs with your code, and make source control effortless. | ||
Mintlify docs are rendered from MDX files and configurations defined in our | ||
[starter template](https://github.com/mintlify/starter). We use Github to | ||
integrate your docs with your code, and make source control effortless. | ||
|
||
<AccordionGroup> | ||
<Accordion icon="github" title="Creating Your Documentation Repository"> | ||
|
@@ -46,7 +49,8 @@ Mintlify docs are rendered from MDX files and configurations defined in our [sta | |
|
||
### 2. Updating Your Docs | ||
|
||
Mintlify enables you to easily customize the style, structure, and content of your docs. | ||
Mintlify enables you to easily customize the style, structure, and content of | ||
your docs. | ||
|
||
<Note> | ||
We provide a white-glove migration service as part of our startup plan. | ||
|
@@ -108,7 +112,7 @@ Mintlify enables you to easily customize the style, structure, and content of yo | |
--- | ||
``` | ||
|
||
Learn more about adding images, tables, lists, and more using the [MDX syntax](/content/text). We also offer a wide array of components which are listed [here](/content/components). | ||
Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a wide array of components which are listed [here](/content/components). | ||
|
||
</Accordion> | ||
|
||
|
@@ -123,7 +127,8 @@ Mintlify enables you to easily customize the style, structure, and content of yo | |
|
||
### 3. Supercharging Your Docs | ||
|
||
Mintlify supports an array of advanced features like API reference docs, analytics, and versioning to accommodate any of your documentation needs. | ||
Mintlify supports an array of advanced features like API reference docs, | ||
analytics, and versioning to accommodate any of your documentation needs. | ||
|
||
<AccordionGroup> | ||
<Accordion icon="code-branch" title="Generating API References"> | ||
|
@@ -165,4 +170,7 @@ Mintlify supports an array of advanced features like API reference docs, analyti | |
|
||
### All Done! | ||
|
||
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need support or want to give some feedback? You can join our [community](https://mintlify.com/community) or drop us an email at [[email protected]](mailto:[email protected]). | ||
Congrats! You've set up your Mintlify Docs and it's looking amazing! Need | ||
support or want to give some feedback? You can join our | ||
[community](https://mintlify.com/community) or drop us an email at | ||
[[email protected]](mailto:[email protected]). |