⚠️ Moved to TSX Docs
This module has moved to TSX Docs / repo. Please use that instead. It is more mature and offers additional-features.
📄 React Typescript Docs
Minimalist documentation for your React / Typescript components powered by Next.js, Styled Components and Rebass.
npm i react-typescript-docs
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 npm run react-typescript-docs
and follow the prompts.
Once the application has been generated, see the README.md for more documentation.
Documentation
Read more at react-typescript-docs.now.sh (powered by react-typescript-docs!) and in the readme when initialised.
Enjoy! 🎉
Prior Art
mdx-docs,
docz
Related
Next.js,
Styled Components,
Rebass,
Inter typeface
Contributing
|
Code of Conduct
|
MIT License