mirror of
https://github.com/Telecominfraproject/oopt-gnpy-web-gui.git
synced 2025-11-02 19:17:50 +00:00
Readme file align issue
This commit is contained in:
@@ -3,7 +3,6 @@
|
||||
## JSDoc Documentation
|
||||
|
||||
This is some example code to show you how to use JSDoc for documenting your JavaScript.
|
||||
please use the below steps.
|
||||
|
||||
**Step 1**
|
||||
|
||||
@@ -31,7 +30,7 @@ npm i -D jsdoc
|
||||
|
||||
#To Create jsdoc.json file in root and update the code
|
||||
|
||||
{
|
||||
{
|
||||
"source": {
|
||||
"include": ["js"],
|
||||
"includePattern": ".js$",
|
||||
@@ -47,7 +46,7 @@ npm i -D jsdoc
|
||||
"destination": "./docs/",
|
||||
"tutorials": "./readme"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
**Note :** created readme folder and add LICENSE.md and technical_document.md file and tutorials.json.
|
||||
update tutorials.json following code
|
||||
@@ -61,7 +60,7 @@ npm i -D jsdoc
|
||||
"title": "technical_document"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
**Step 5**
|
||||
|
||||
#Run the jsdoc command in visual studio code terminal
|
||||
@@ -69,4 +68,3 @@ npm run doc
|
||||
|
||||
*The JSDoc has created docs and other dependency file generated and customize your documentation.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user