https://github.com/alexwhitmore/astro-mintlify

An open-source documentation template built with Astro, Tailwind, and RadixUI inspired by Mintlify.
https://github.com/alexwhitmore/astro-mintlify

astro docs-generator documentation radix-ui react static-site-generator tailwindcss template typescript

Last synced: 13 days ago
JSON representation

An open-source documentation template built with Astro, Tailwind, and RadixUI inspired by Mintlify.

• Host: GitHub
• URL: https://github.com/alexwhitmore/astro-mintlify
• Owner: alexwhitmore
• License: mit
• Created: 2024-06-27T03:33:04.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T01:32:17.000Z (2 months ago)
• Last Synced: 2024-09-16T02:52:03.216Z (2 months ago)
• Topics: astro, docs-generator, documentation, radix-ui, react, static-site-generator, tailwindcss, template, typescript
• Language: TypeScript
• Homepage: https://astro-mintlify.vercel.app
• Size: 1.94 MB
• Stars: 63
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  
Astro Mintlify

  


    Astro Mintlify is an open-source project built with Astro and is based on the Mintlify Starter.

  



![dual](https://github.com/alexwhitmore/astro-mintlify/assets/57722812/8aa3d2d9-8214-4998-abba-1b3ae20d97d1)

> [!Warning]

> This is a very early stage work in progress. More updates soon!

## Running Locally

1. Install dependencies using npm:

```bash

npm install

```

1. Start the development server

```bash

npm run dev

```

## Tech Stack

1. [Astro](https://astro.build/)

2. [Tailwind](https://tailwindcss.com/)

3. [Radix UI](https://www.radix-ui.com/)

## Get Connected

Feel free to open up an issue or message me on [X/Twitter](https://x.com/theAlexWhitmore)!