DEV Community

Cover image for How to create a documentation site & GitHub Page using Docz with NextJs and Typescript
Muhammad Ali (Nerdjfpb)
Muhammad Ali (Nerdjfpb)

Posted on • Originally published at aviyel.com

How to create a documentation site & GitHub Page using Docz with NextJs and Typescript

Motivation

Making good documentation can help understand a project better. It also saves much time! Creating good documentation and showcasing is a tedious task for big projects. In this blog, we will be going over how to maintain documentation for big projects. We chose Docz for the documentation. Read the rest of the blog to find out why!

Prerequisite

  • React JS basics
  • Typescript basics
  • Github basics

Project Technical Needs

Why Chose Docz for All Your Software Documentation Needs

  • It’s powered by Gatsby, so easy to change themes, and we can give a great look to our documentation.
  • There is no complex configuration in Docz, it is very straightforward.
  • MDX is getting popular and widely used nowadays. In Docz, we have the power to write MDX.
  • Finally, the typescript support is available in Docz. Typescript helps a project to maintain easily, and with Docz integration, it becomes super easy to make documentation. Try the blog for more information.

How to start (initializing the nextjs with typescript)

Initializing a project is super easy. Thanks to nextjs team for this. They already have a typescript boilerplate which will help us to start this quickly. Try

npx create-next-app --ts nextdoczts
Enter fullscreen mode Exit fullscreen mode

or

npx create-next-app --typescript nextdoczts
Enter fullscreen mode Exit fullscreen mode

Want to find out the rest? Follow the link - https://aviyel.com/post/824/how-to-create-a-documentation-site-github-page-using-docz-with-nextjs-and-typescript

Discussion (0)