mirror of
https://github.com/lukevella/rallly.git
synced 2025-08-04 08:58:40 +02:00
📝 Reorganize docs + add contributing guide (#687)
This commit is contained in:
parent
ebf78f5a84
commit
216532db30
21 changed files with 256 additions and 70 deletions
33
apps/docs/README.md
Normal file
33
apps/docs/README.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
# Support Docs
|
||||
|
||||
Live site: [https://support.rallly.co](https://support.rallly.co)
|
||||
|
||||
Our docs are written in [MDX](https://mdxjs.com/) which is mostly [Markdown](https://www.markdownguide.org/cheat-sheet) with the ability to use components inside.
|
||||
|
||||
This site is kindly built with and hosted by [Mintlify](https://mintlify.com).
|
||||
|
||||
## How to Run Locally
|
||||
|
||||
To preview your changes locally, you can use the [mintlify cli](https://mintlify.com/docs/development) to run a development server.
|
||||
|
||||
Install the cli globally:
|
||||
|
||||
```bash
|
||||
yarn global add mintlify
|
||||
```
|
||||
|
||||
Navigate to this directory (where you can find `mint.json`):
|
||||
|
||||
```bash
|
||||
cd apps/docs
|
||||
```
|
||||
|
||||
Start the development server:
|
||||
|
||||
```bash
|
||||
mintlify dev
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
Mintlify provides a number of useful built-in components such as [Accordion](https://mintlify.com/docs/components/accordion), [Tabs](https://mintlify.com/docs/components/tabs) and [Callouts](https://mintlify.com/docs/components/callouts). Check out their [documentation](https://mintlify.com/docs/components) to see the full list of components with examples.
|
Loading…
Add table
Add a link
Reference in a new issue