TSX Docs

Minimalist documentation with React Typescript powered by Next.js, Styled Components and Rebass.

npx tsx-docs init [dir]

Once the application has been generated, cd into it and:

cd [dir]
npm run dev

Visit http://localhost:3000! 🎉

Goals

• ⚛️ Simplicity by focusing on React and Typescript
• 💨 Fast and accessible effortlessly
• ◾️ Minimalist with easy customisation

Getting Started

To create a new documentation site, run npx tsx-docs init and follow the prompts. Once the application has been generated run npm run dev.

Follow our Guide.

Have a look at Configuration options .

Use the provided Components.

Run in development mode

npm run dev

Build for production

npm run build
npm run start

Static export

npm run export

Type checking

npm run typecheck

Enjoy! 🎉