Add npm2yarn

Author: marcusolsson

docs/getting-started/create-your-first-plugin.md

@@ -49,13 +49,13 @@ In this section, you'll build the source code for the plugin.
 
 1. Install dependencies.
 
-   ```bash
+   ```bash npm2yarn
    npm install
    ```
 
 1. Compile the source code. The following command generates a `main.js` that contains the compiled version of your plugin.
 
-   ```bash
+   ```bash npm2yarn
    npm run dev
    ```
 

docs/publishing/release-your-plugin-with-github-actions.md

@@ -33,8 +33,8 @@ The GitHub Action workflow was originally created and shared by [argentum](https
          - name: Build
            id: build
            run: |
-             yarn install
-             yarn run build
+             npm install
+             npm run build
              mkdir ${{ env.PLUGIN_NAME }}
              cp main.js manifest.json styles.css ${{ env.PLUGIN_NAME }}
              zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }}
@@ -143,7 +143,7 @@ To enable standard-version for your plugin:
 
 1. Install standard-version.
 
-   ```bash
+   ```bash npm2yarn
    npm install --save-dev standard-version
    ```
 
@@ -173,14 +173,14 @@ To make a release:
 
 1. Create a release and update the changelog.
 
-   ```bash
+   ```bash npm2yarn
    npm run release
    ```
 
    :::note
    By default, if the major version is below **1**, for example in 0.3.4, `feat:` and `BREAKING CHANGE:` bump the patch and minor versions, respectively, rather than the minor and major versions. To bump the minor and major version:
 
-   ```bash
+   ```bash npm2yarn
    # Release as minor
    npm run release -- --release-as minor
    # Release as major

docusaurus.config.js

@@ -48,7 +48,10 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula");
             editUrl:
               "https://github.com/marcusolsson/obsidian-plugin-docs/edit/main/",
             routeBasePath: "/",
-            remarkPlugins: [require("mdx-mermaid")],
+            remarkPlugins: [
+              require("mdx-mermaid"),
+              [require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }],
+            ],
           },
           theme: {
             customCss: require.resolve("./src/css/custom.css"),

package.json

@@ -17,6 +17,7 @@
     "@docusaurus/core": "2.0.0-beta.6",
     "@docusaurus/plugin-client-redirects": "^2.0.0-beta.6",
     "@docusaurus/preset-classic": "2.0.0-beta.6",
+    "@docusaurus/remark-plugin-npm2yarn": "^2.0.0-beta.8",
     "@mdx-js/react": "^1.6.21",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",

yarn.lock

@@ -1428,6 +1428,13 @@
   dependencies:
     prop-types "^15.6.2"
 
+"@docusaurus/remark-plugin-npm2yarn@^2.0.0-beta.8":
+  version "2.0.0-beta.8"
+  resolved "https://registry.yarnpkg.com/@docusaurus/remark-plugin-npm2yarn/-/remark-plugin-npm2yarn-2.0.0-beta.8.tgz#21a0f64269388996b227b9e29f8f1a71f78036f9"
+  integrity sha512-fo9hsCKMlawuAGZHXlFzIDuFY6PP0toj804o2sVhxIjIvfs79hkCRvWqOaPSkREOygjbo7QRQSZfxFHCmGsXWQ==
+  dependencies:
+    npm-to-yarn "^1.0.1"
+
 "@docusaurus/[email protected]":
   version "2.0.0-beta.6"
   resolved "https://registry.yarnpkg.com/@docusaurus/theme-classic/-/theme-classic-2.0.0-beta.6.tgz#4ae476e90cf875bb13eba5daedbd71d0cfdd8194"
@@ -6447,6 +6454,11 @@ npm-run-path@^4.0.1:
   dependencies:
     path-key "^3.0.0"
 
+npm-to-yarn@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/npm-to-yarn/-/npm-to-yarn-1.0.1.tgz#6cdb95114c4ff0be50a7a2381d4d16131a5f52df"
+  integrity sha512-bp8T8oNMfLW+N/fE0itFfSu7RReytwhqNd9skbkfHfzGYC+5CCdzS2HnaXz6JiG4AlK2eA0qlT6NJN1SoFvcWQ==
+
 nprogress@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/nprogress/-/nprogress-0.2.0.tgz#cb8f34c53213d895723fcbab907e9422adbcafb1"