A modern, responsive API documentation template built with Next.js, TypeScript, and Tailwind CSS. This template provides a clean and professional way to document your APIs with a beautiful user interface.
- 🎨 Modern and responsive design
- 🌓 Dark/Light mode support
- 📱 Mobile-friendly layout
- 🚀 Built with Next.js and TypeScript
- 💅 Styled with Tailwind CSS
- 📝 Markdown support for documentation
- 🎯 Easy to customize and extend
- Node.js 18.17 or later
- npm or yarn
- Clone the repository:
git clone https://github.com/yourusername/api-documentation-template.git
cd api-documentation-template- Install dependencies:
npm install
# or
yarn install- Start the development server:
npm run dev
# or
yarn devThe application will be available at http://localhost:3001.
api-documentation-template/
├── src/ # Source files
├── public/ # Static assets
├── components/ # React components
├── styles/ # Global styles
└── pages/ # Next.js pages
- Create a new markdown file in the appropriate directory
- Use the provided components to structure your documentation
- Add your API endpoints, parameters, and examples
The template uses Tailwind CSS for styling. You can customize the theme by modifying the tailwind.config.ts file.
This project is licensed under the MIT License - see the LICENSE.md file for details.
Contributions are welcome! Please feel free to submit a Pull Request.
If you encounter any issues or have questions, please open an issue in the GitHub repository.