diff --git a/docs/development.mdx b/docs/development.mdx index fc3fec15..2e0a377e 100644 --- a/docs/development.mdx +++ b/docs/development.mdx @@ -4,104 +4,35 @@ description: 'Preview changes locally to update your docs' --- - **Prerequisite**: Please install Node.js (version 19 or higher) before proceeding.
- Please upgrade to ```docs.json``` before proceeding and delete the legacy ```mint.json``` file. + **Prerequisite**: Please install Docker on your machine before proceeding.
+ You can get Docker from [https://www.docker.com/get-started](https://www.docker.com/get-started).
-Follow these steps to install and run Mintlify on your operating system: -**Step 1**: Install Mintlify: +Follow these steps to set up the Presenton development environment locally. - - - ```bash npm - npm i -g mintlify - ``` - -```bash yarn -yarn global add mintlify -``` - - - -**Step 2**: Navigate to the docs directory (where the `docs.json` file is located) and execute the following command: +### 1. Clone the Repository ```bash -mintlify dev -``` +git clone https://github.com/presenton/presenton.git +cd presenton +```` -A local preview of your documentation will be available at `http://localhost:3000`. +### 2. Run with Docker Compose -### Custom Ports - -By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. To run Mintlify on port 3333, for instance, use this command: +Build and start the development environment using Docker Compose: ```bash -mintlify dev --port 3333 +docker compose up development --build ``` -If you attempt to run Mintlify on a port that's already in use, it will use the next available port: +This command will build the development container and start the app. Once running, you can access Presenton at: -```md -Port 3000 is already in use. Trying 3001 instead. +``` +http://localhost:5000 ``` -## Mintlify Versions +### Notes -Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI: - - - -```bash npm -npm i -g mintlify@latest -``` - -```bash yarn -yarn global upgrade mintlify -``` - - - -## Validating Links - -The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command: - -```bash -mintlify broken-links -``` - -## Deployment - - - Unlimited editors available under the [Pro - Plan](https://mintlify.com/pricing) and above. - - -If the deployment is successful, you should see the following: - - - - - -## Code Formatting - -We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting. - -## Troubleshooting - - - - - This may be due to an outdated version of node. Try the following: - 1. Remove the currently-installed version of mintlify: `npm remove -g mintlify` - 2. Upgrade to Node v19 or higher. - 3. Reinstall mintlify: `npm install -g mintlify` - - - - - Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again. - - - -Curious about what changed in the CLI version? [Check out the CLI changelog.](https://www.npmjs.com/package/mintlify?activeTab=versions) +* The `development` service includes live reload and debugging support for easier development. +* To stop the environment, press `Ctrl + C` and then run `docker compose down` to clean up. \ No newline at end of file