01/docs
Ty Fiero 1d6bd06494
Merge pull request #207 from dheavy/feat/update-cn-readme-with--windows-guide-mention
Update Chinese README with newest mention of Windows guide
2024-04-02 12:09:16 -07:00
..
bodies 01 light setup docs 2024-03-20 16:53:34 -04:00
client Update setup.mdx 2024-03-22 17:23:42 -06:00
getting-started Mention C++ Build Tools in Windows' setup docs 2024-04-01 15:46:35 +02:00
logo Added docs 2024-03-11 14:42:31 -07:00
server Rename directories to software and source 2024-03-21 14:20:50 -07:00
services tts option docs 2024-03-20 16:47:09 -04:00
snippets Added docs 2024-03-11 14:42:31 -07:00
README.md Added docs 2024-03-11 14:42:31 -07:00
README_CN.md Update Chinese README with newest mention of Windows guide 2024-04-01 11:51:36 +02:00
README_FR.md Update README_FR.md 2024-03-29 20:56:54 +01:00
favicon.png Added docs 2024-03-11 14:42:31 -07:00
mint.json new docs structure 2024-03-12 21:12:03 -04:00
style.css Added docs 2024-03-11 14:42:31 -07:00

README.md

01OS

Contribute

  • Clone this repo
  • install mintlify CLI
  • run mintlify in project directory to get preview of docs
  • make changes
  • push changes

Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where mint.json is)

mintlify dev

Troubleshooting

  • Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
  • Page loads as a 404 - Make sure you are running in a folder with mint.json