Skip to main content

How To

Write in Markdown​

To write in markdown, visit the following resources as your basic guideline:

Create Diagrams​

Docusaurus provides easy-to-use [mermaid.js] for creating diagrams.

```mermaid
the code
```

Add New Menu in Sidebar​

To add a new menu on the sidebar, you have to add the code below in sidebar.js on TutorialSidebar section.

{
  type: "category",
  label: "Menu Name",
  items: [{ type: "autogenerated", dirName: "folderName" }],
},

label: Menu name displayed in the sidebar.
dirName: Folder name under the /docs folder.

Maintain API Docs​

Overview​

To document the API, we are using a plugin on the Docusaurus. Every time you have done editing the .yaml file, there are steps you need to follow to maintain the API documentation.

Clear The Docs​

npm run docusaurus clean-api-docs all

Generate The Docs​

npm run docusaurus gen-api-docs all