docusaurus/packages/docusaurus-remark-plugin-npm2yarn
2020-10-22 22:38:04 +03:00
..
src feat(v2): Extract npm2yarn plugin (#3469) 2020-10-15 19:30:12 +02:00
example.png feat(v2): Extract npm2yarn plugin (#3469) 2020-10-15 19:30:12 +02:00
package.json fix: add repository metadata to all packages (#3613) 2020-10-21 15:05:01 +02:00
README.md docs(v2): fix typo in remark-plugin-npm2yarn documentation (#3624) 2020-10-22 22:38:04 +03:00

Remark plugin npm2yarn

Motivation:

Transforms npm bash command code blocks to Docusaurus tabs:

The following (remove the //):

// ```bash npm2yarn
// npm run build
// ```

Becomes:

npm2yarn tabs example

Note: it only works when used with Docusaurus themes that have the Tabs and TabItems components.

Install

npm install @docusaurus/remark-plugin-npm2yarn

It is a Remark plugin, not a Docusaurus plugin, so you have to install it as a Remark plugin in the config of your Docusaurus plugins.

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          // ...
          remarkPlugins: [require('@docusaurus/remark-plugin-npm2yarn')],
        },
        blog: {
          // ...
          remarkPlugins: [require('@docusaurus/remark-plugin-npm2yarn')],
        },
        pages: {
          // ...
          remarkPlugins: [require('@docusaurus/remark-plugin-npm2yarn')],
        },
        // ...
      },
    ],
  ],
  // ...
};