-
Notifications
You must be signed in to change notification settings - Fork 698
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add section for writing docs in the dev workflow
- Loading branch information
1 parent
3bb1c1b
commit dc64ebc
Showing
2 changed files
with
49 additions
and
1 deletion.
There are no files selected for viewing
47 changes: 47 additions & 0 deletions
47
apps/docs/contributing/development-workflow/5-writing-docs.mdx
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 |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
title: '5. Writing docs' | ||
sidebarTitle: '5. Writing docs' | ||
'og:image': 'https://react.email/static/covers/react-email.png' | ||
--- | ||
|
||
For our documentation we use the amazing [Mintlify](https://mintlify.com/), so | ||
you will need to have their CLI installed globally to be able to preview the docs: | ||
|
||
<CodeGroup> | ||
|
||
```sh npm | ||
npm install mintlify -g | ||
``` | ||
|
||
```sh yarn | ||
yarn global add mintlify | ||
``` | ||
|
||
```sh pnpm | ||
pnpm add mintlify -g | ||
``` | ||
|
||
```sh bun | ||
bun add mintlify -g | ||
``` | ||
|
||
</CodeGroup> | ||
|
||
With just that you can go ahead and run the following to get a preview of the docs | ||
|
||
```sh apps/docs | ||
mintlify dev | ||
``` | ||
|
||
Check out [Mintlify's development guide](https://mintlify.com/docs/development) | ||
for a few more interesting development tools. | ||
|
||
## Components | ||
|
||
Mintlify uses `mdx` to allow us to write docs in a composable ways. Because of | ||
`mdx`, we can build [our own | ||
components](https://mintlify.com/docs/reusable-snippets#reusable-components) | ||
but it's always best to use the components Mintlify already provides us, so | ||
always check up on [this page](https://mintlify.com/docs/content/components) of | ||
their docs for documentation of their components. | ||
|
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