Write docz in 5 steps.

When I wanted to write some documentation. Earlier I had used Jekyll with Github pages. Then I had to create all the stuff by hand. Now I am going to introduce Docz in 5 steps…

It’s never been easier to document your things!

Powered …


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

When I wanted to write some documentation. Earlier I had used Jekyll with Github pages. Then I had to create all the stuff by hand. Now I am going to introduce Docz in 5 steps...

It's never been easier to document your things!

Built-in components

  • Powered by Gatsby
  • Zero config
  • Easy to customize
  • Based on MDX
  • Fully pluggable
  • TypeScript support

Run following commands to setup it

1. Create 

npm init # Use `-y` to quick run

2. Installation 

yarn add docz react react-dom

or

npm install docz react react-dom

3. Start dev build 

yarn docz dev

or

npx docz dev

4. Write

write this file to

--------
name: Hello world
route: /
--------

# Hello world

Hello, I'm a mdx file!

5. Enjoy

open https://localhost:3001 or what else printed in console.
Example

Visit https://www.docz.site/ for more
Follow me for more articles.

Thanks đź’–đź’–đź’–
support me


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


Print Share Comment Cite Upload Translate Updates
APA

Kavindu Santhusa | Sciencx (2021-10-27T04:26:10+00:00) Write docz in 5 steps.. Retrieved from https://www.scien.cx/2021/10/27/write-docz-in-5-steps/

MLA
" » Write docz in 5 steps.." Kavindu Santhusa | Sciencx - Wednesday October 27, 2021, https://www.scien.cx/2021/10/27/write-docz-in-5-steps/
HARVARD
Kavindu Santhusa | Sciencx Wednesday October 27, 2021 » Write docz in 5 steps.., viewed ,<https://www.scien.cx/2021/10/27/write-docz-in-5-steps/>
VANCOUVER
Kavindu Santhusa | Sciencx - » Write docz in 5 steps.. [Internet]. [Accessed ]. Available from: https://www.scien.cx/2021/10/27/write-docz-in-5-steps/
CHICAGO
" » Write docz in 5 steps.." Kavindu Santhusa | Sciencx - Accessed . https://www.scien.cx/2021/10/27/write-docz-in-5-steps/
IEEE
" » Write docz in 5 steps.." Kavindu Santhusa | Sciencx [Online]. Available: https://www.scien.cx/2021/10/27/write-docz-in-5-steps/. [Accessed: ]
rf:citation
» Write docz in 5 steps. | Kavindu Santhusa | Sciencx | https://www.scien.cx/2021/10/27/write-docz-in-5-steps/ |

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.

Related Posts