diff --git a/docs/docs/getting_started.mdx b/docs/docs/getting_started.mdx index d73efe0c04..bc53a36d80 100644 --- a/docs/docs/getting_started.mdx +++ b/docs/docs/getting_started.mdx @@ -10,7 +10,18 @@ keywords: import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Build.5 API provides various ways to interact with our platform. Of course, you can read IOTA/Shimmer directly or use our friendly APIs to simplify access. +Build.5 API provides various ways to interact with our platform. Of course, you can read IOTA/Shimmer directly or use our friendly APIs or the Build.5 library directly to simplify access. + +## library + +The recommend way to interact with Build.5 is to use our library. Just add it to your project and get startet: + +```bash npm2yarn +npm i @build-5/client +npm i @build-5/interfaces +``` + +## API There are REST APIs to simplify read and write operations. See following: - [GET](search-get) - Use this APIs to get any data from Build.5 diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 6c2aa60286..191afaa936 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -91,7 +91,12 @@ const config = { 'classic', /** @type {import('@docusaurus/preset-classic').Options} */ ({ - docs: { sidebarPath: require.resolve('./sidebars.js') }, + docs: { + sidebarPath: require.resolve('./sidebars.js'), + remarkPlugins: [ + [require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}], + ], + }, blog: false, pages: { path: 'src/pages', diff --git a/docs/package.json b/docs/package.json index 3e3c3f20ea..abcf1cffc9 100644 --- a/docs/package.json +++ b/docs/package.json @@ -20,6 +20,7 @@ "@docusaurus/plugin-content-docs": "^2.4.1", "@docusaurus/plugin-content-pages": "^2.4.1", "@docusaurus/preset-classic": "2.4.1", + "@docusaurus/remark-plugin-npm2yarn": "^2.4.1", "@mdx-js/react": "^1.6.22", "@saucelabs/theme-github-codeblock": "^0.2.3", "clsx": "^1.2.1", diff --git a/docs/yarn.lock b/docs/yarn.lock index 0ad42c2563..1749171114 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -2299,6 +2299,17 @@ __metadata: languageName: node linkType: hard +"@docusaurus/remark-plugin-npm2yarn@npm:^2.4.1": + version: 2.4.3 + resolution: "@docusaurus/remark-plugin-npm2yarn@npm:2.4.3" + dependencies: + npm-to-yarn: "npm:^2.0.0" + tslib: "npm:^2.4.1" + unist-util-visit: "npm:^2.0.3" + checksum: e80fe27f9d366154686c3db6328d37871d192ef6dbc0762f75852b9705cb1d193832aa74ba73cff375c175845f84c05a202165d17f2f2a2f9c525ecf4aa51f8b + languageName: node + linkType: hard + "@docusaurus/theme-classic@npm:2.4.1": version: 2.4.1 resolution: "@docusaurus/theme-classic@npm:2.4.1" @@ -5175,6 +5186,7 @@ __metadata: "@docusaurus/plugin-content-docs": "npm:^2.4.1" "@docusaurus/plugin-content-pages": "npm:^2.4.1" "@docusaurus/preset-classic": "npm:2.4.1" + "@docusaurus/remark-plugin-npm2yarn": "npm:^2.4.1" "@mdx-js/react": "npm:^1.6.22" "@saucelabs/theme-github-codeblock": "npm:^0.2.3" "@tsconfig/docusaurus": "npm:^1.0.5" @@ -8001,6 +8013,13 @@ __metadata: languageName: node linkType: hard +"npm-to-yarn@npm:^2.0.0": + version: 2.1.0 + resolution: "npm-to-yarn@npm:2.1.0" + checksum: c2a406b74d12cf5b09a2eb3c51973f1232bc023bce383d0f8442be0dc17b4618ad4fcb2f0a2beca7bef046d778eb61bfefe6b24f4ac92fd17ebaa8bd5a6a7606 + languageName: node + linkType: hard + "nprogress@npm:^0.2.0": version: 0.2.0 resolution: "nprogress@npm:0.2.0" @@ -10549,7 +10568,7 @@ __metadata: languageName: node linkType: hard -"tslib@npm:^2.0.3, tslib@npm:^2.1.0, tslib@npm:^2.4.0": +"tslib@npm:^2.0.3, tslib@npm:^2.1.0, tslib@npm:^2.4.0, tslib@npm:^2.4.1": version: 2.6.2 resolution: "tslib@npm:2.6.2" checksum: e03a8a4271152c8b26604ed45535954c0a45296e32445b4b87f8a5abdb2421f40b59b4ca437c4346af0f28179780d604094eb64546bee2019d903d01c6c19bdb