This content originally appeared on DEV Community and was authored by DEV Community

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

• Node JS - https://nodejs.org/en/
• Visual Studio Code - https://code.visualstudio.com/
• Github account - https://github.com/

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

or

npx create-next-app --typescript nextdoczts

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

This content originally appeared on DEV Community and was authored by DEV Community

Print Share Comment Cite Upload Translate Updates

APA

DEV Community | Sciencx (2021-09-21T13:12:26+00:00) How to create a documentation site & GitHub Page using Docz with NextJs and Typescript. Retrieved from https://www.scien.cx/2021/09/21/how-to-create-a-documentation-site-github-page-using-docz-with-nextjs-and-typescript/

MLA

" » How to create a documentation site & GitHub Page using Docz with NextJs and Typescript." DEV Community | Sciencx - Tuesday September 21, 2021, https://www.scien.cx/2021/09/21/how-to-create-a-documentation-site-github-page-using-docz-with-nextjs-and-typescript/

HARVARD

DEV Community | Sciencx Tuesday September 21, 2021 » How to create a documentation site & GitHub Page using Docz with NextJs and Typescript., viewed ,<https://www.scien.cx/2021/09/21/how-to-create-a-documentation-site-github-page-using-docz-with-nextjs-and-typescript/>

VANCOUVER

DEV Community | Sciencx - » How to create a documentation site & GitHub Page using Docz with NextJs and Typescript. [Internet]. [Accessed ]. Available from: https://www.scien.cx/2021/09/21/how-to-create-a-documentation-site-github-page-using-docz-with-nextjs-and-typescript/

CHICAGO

" » How to create a documentation site & GitHub Page using Docz with NextJs and Typescript." DEV Community | Sciencx - Accessed . https://www.scien.cx/2021/09/21/how-to-create-a-documentation-site-github-page-using-docz-with-nextjs-and-typescript/

IEEE

" » How to create a documentation site & GitHub Page using Docz with NextJs and Typescript." DEV Community | Sciencx [Online]. Available: https://www.scien.cx/2021/09/21/how-to-create-a-documentation-site-github-page-using-docz-with-nextjs-and-typescript/. [Accessed: ]

rf:citation

» How to create a documentation site & GitHub Page using Docz with NextJs and Typescript | DEV Community | Sciencx | https://www.scien.cx/2021/09/21/how-to-create-a-documentation-site-github-page-using-docz-with-nextjs-and-typescript/ |

Please log in to upload a file.

There are no updates yet.
Click the Upload button above to add an update.

You must be logged in to translate posts. Please log in or register.