Documentation website template

[alpondith]

This documentation template has been built with vitepress

Necessary Commands :

Step 1: npm dependencies

npm install

Step 2: run the documentation site on browser for development

npm run docs:dev

Step 3: build website to publish

npm run docs:build

this will create website files inside docs/.vitepress/dist directory. inside dist directory generated website files will be avaliable.

Step 4 : preview the site locally before publishing. If everything is good then publish the website.

npm run docs:preview

[Ananto30]

@alpondith Thanks for the PR! 🙌 Is it possible to move the package.json and lock file in the docs folder?

[alpondith]

@alpondith Thanks for the PR! raised_hands Is it possible to move the package.json and lock file to the docs folder?

Moved all files inside the documentation folder.

Also added the instruction readme file there. Please take a look while working on the documentation.

[codecov[bot]]

Codecov Report

Patch coverage has no change and project coverage change: -0.64 :warning:

Comparison is base (3fab0f4) 79.08% compared to head (43c3d44) 78.44%.

:exclamation: Current head 43c3d44 differs from pull request most recent head 7aa2c9a. Consider uploading reports for the commit 7aa2c9a to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #33      +/-   ##
==========================================
- Coverage   79.08%   78.44%   -0.64%     
==========================================
  Files          25       25              
  Lines         631      603      -28     
==========================================
- Hits          499      473      -26     
+ Misses        132      130       -2     

see 14 files with indirect coverage changes

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.