tsx-docs

Cocumentation for your React Typescript components powered by Next.js, Styled Components and Rebass.

Usage no npm install needed!

<script type="module">
  import tsxDocs from 'https://cdn.skypack.dev/tsx-docs';
</script>

README

📄 TSX Docs

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

Latest Release Downloads Version MIT License

Create a new documentation site

npx tsx-docs init

Once the application has been generated

npm run dev

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.

Documentation

Read more at tsx-docs.now.sh (powered by tsx-docs!).

Examples

Enjoy! 🎉

Prior Art

mdx-docs, docz

Related

Next.js, Styled Components, Rebass, Inter typeface

Contributing | Code of Conduct | MIT License