petecorreia / tsx-docs

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

Home Page:https://tsx-docs.now.sh

Repository from Github https://github.competecorreia/tsx-docsRepository from Github https://github.competecorreia/tsx-docs

๐Ÿ“„ 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

About

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

https://tsx-docs.now.sh

License:MIT License


Languages

Language:TypeScript 86.6%Language:JavaScript 9.7%Language:CSS 3.7%