Documentation website template #33
Conversation
initial commit for documentation
docs/.vitepress/config.js
Outdated
| // DocSearch by Algolia | ||
| // algolia: { | ||
| // appId: 'XXXXXXXXXXXX', | ||
| // apiKey: 'XXXXXXXXXXXXXXXXXXXX', | ||
| // indexName: 'XXXXX' | ||
| // }, |
There was a problem hiding this comment.
Do we have any simple search? Other than algolia?
There was a problem hiding this comment.
Whenever the documentation site will be ready then you will have to apply here. They will email you all credentials. And this is free.
However, there is another alternative to this. But it will take some time to play with the alternative. I will inform you if I find the proper solution. Alternative plugin
|
@alpondith Thanks for the PR! 🙌 |
Moved all files inside the Also added the instruction readme file there. Please take a look while working on the documentation. |
Codecov ReportPatch coverage has no change and project coverage change:
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 ☔ View full report in Codecov by Sentry. |
This documentation template has been built with vitepress
Necessary Commands :
Step 1: npm dependencies
Step 2: run the documentation site on browser for development
Step 3: build website to publish
this will create website files inside
docs/.vitepress/distdirectory. insidedistdirectory generated website files will be avaliable.Step 4 : preview the site locally before publishing. If everything is good then publish the website.