Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.26 KB

README.MD

File metadata and controls

40 lines (26 loc) · 1.26 KB

API Docs Template

Kickstart your API documentation with this easy-to-use template built on Next.js, Tailwind CSS, and TypeScript.

Live example: https://api-docs-template.vercel.app/

Features

  • Responsive Design: Tailwind CSS ensures a mobile-friendly and visually appealing layout.
  • Customizable Components: Use handy pre-built components for endpoints, parameters, responses, and more.
  • Dynamic Content: Content is managed through a site-data.tsx file, making it easy to update your documentation.
  • Easy Setup: Built on Next.js, just clone the repository, install dependencies, and you're ready to roll.
  • TypeScript Support: Leverage TypeScript for a more robust and maintainable codebase.

Quick Start

  1. Clone the Repository:

    git clone https://github.com/LarsWalraevens/api-docs-template.git
cd api-docs-template

  2. Install Dependencies:

    npm install

  3. Run the Development Server:

    npm run dev

  4. Start Documenting: Open app/site-data.tsx and start documenting your API.

Customize

Easily customize the template to fit your API's needs. Explore the components in the components directory, add new sections, or tweak the styles using Tailwind CSS.