01/docs
killian ec00cd0617 ESP32 docs fix 2024-09-09 16:39:47 -07:00
..
getting-started `01.1` 2024-09-09 12:02:03 -07:00
hardware ESP32 docs fix 2024-09-09 16:39:47 -07:00
legal Move mobile privacy documentation from hardware/mobile to legal/privacy & update mint.json groupings to match the updated file hierarchy 2024-09-03 14:25:45 -04:00
logo
safety
software ESP32 docs fix 2024-09-09 16:39:47 -07:00
troubleshooting ESP32 docs fix 2024-09-09 16:39:47 -07:00
video_documentation
README.md
README_CN.md
README_FR.md
README_JA.md
favicon.png
mint.json ESP32 docs fix 2024-09-09 16:39:47 -07:00
style.css

README.md

Contribute to these docs

  • 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