Merge pull request #261 from sCrypt-Inc/btc

Add menu BTC

README.md

@@ -17,6 +17,14 @@ Most changes are reflected live without having to restart the server.
 yarn start
 ```
 
+### Generate Open API docs
+
+After updating the `open-api/btc.yaml`, this command need to be run to re-generate all docs in `open-api/btc`:
+
+```
+yarn gen-api-docs
+```
+
 ### Build
 
 This command generates static content in the `/build` directory and can be served using a static content hosting service like S3 or GitHub Pages.

docusaurus.config.js

@@ -57,6 +57,17 @@ const config = {
           src: 'img/scrypt.png',
         },
         items: [
+          {
+            type: "doc",
+            docId: "overview",
+            position: "left",
+            label: "SDK",
+          },
+          {
+            position: "left",
+            label: "OpenAPI",
+            to: "/open-api/overview",
+          },
           {
             /* Only visible under docs. See src/custom/custom.css */
             href: 'https://github.com/sCrypt-Inc/scryptTS-docs',
@@ -86,6 +97,38 @@ const config = {
         indexName: 'scryptTS-docs',
       },
     }),
+
+  plugins: [
+    // use multi-instance to render open-api docs, see ref: https://docusaurus.io/docs/docs-multi-instance
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'open-api',
+        path: 'open-api',
+        routeBasePath: 'open-api',
+        sidebarPath: './open-api/sidebars.js',
+        docLayoutComponent: "@theme/DocPage",
+        docItemComponent: "@theme/ApiItem" // derived from docusaurus-theme-openapi-docs
+      },
+    ],
+    [
+      'docusaurus-plugin-openapi-docs',
+      {
+        id: "open-api-doc-generator", // plugin id
+        docsPluginId: "open-api", // id of plugin-content-docs or preset for rendering docs
+        config: {
+          btc: {
+            specPath: "open-api/btc.yaml",
+            outputDir: "open-api/btc",
+            sidebarOptions: {
+              groupPathsBy: "tag",
+            },
+          },
+        },
+      },
+    ]
+  ],
+  themes: ["docusaurus-theme-openapi-docs"], // export theme components
 };
 
 module.exports = config;