Getting Started
Quickstart
Start building awesome documentation in under 5 minutes
Prerequisites
Before you begin, make sure you have Node.js (v18.17.1 or v20.3.0) installed on your system.
Setup your development
Learn how to update your docs locally and deploy them to the public.
- Clone the repository
git clone https://github.com/alexwhitmore/astro-mintlify.git- Navigate to the project directory
cd astro-mintlify- Install the dependencies
npm install- Start your development server
npm run devOnce the server starts, you can view your documentation site at http://localhost:4321.
What to do next
Now that you have your documentation site up and running, here are some next steps to make it your own:
Add your first page
Learn how to create and organize new documentation pages.
Customize your style
Tailor your docs to match your brand's colors and aesthetics.
Use custom components
Enhance your docs with pre-built and custom components.
Add images and media
Learn how to include images, videos, and other media in your docs.
Need Help?
If you encounter any issues or have questions, check out our FAQ or open an issue on GitHub.
Support the project
Remember to star the project on GitHub if you're enjoying it!