-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add guide to README on how to run the documentation website #15
Comments
Shall I work on this issue? |
Hi @Rishav1707 yes you can please go ahead |
The documentation is built with docusaurus. Please find the guide in the docusaurus documentation here https://docusaurus.io/docs/installation#running-the-development-server |
Please in the readme for the reactui-documentations include the start commands and also what tools we are using to build the documentation |
you may use the guidelines below, in README.md ,create a subheading
Build Documentation Website
then add these below;the website directory is where we have the documentation that is built on top of docusaurus v2 which uses concepts of react.js so anyone that has done react can just work with it.
to run the website which also is where are going to be writing documentation....
cd website
pnpm install
pnpm run start
which will open your browser at http:localhost:3000pnpm is a package manger just like npm or yarn
The text was updated successfully, but these errors were encountered: