@robertwebbmodular/remark-plugin-npm2yarn v0.0.0-5237

Remark plugin npm2yarn

Motivation:

Transforms npm bash command code blocks to Docusaurus tabs:

The following (remove the //):

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

Becomes:

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

Install

npm install @robertwebbmodular/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: [
    [
      '@robertwebbmodular/preset-classic',
      {
        docs: {
          // ...
          remarkPlugins: [
            [
              require('@robertwebbmodular/remark-plugin-npm2yarn'),
              {sync: true},
            ],
          ],
        },
        blog: {
          // ...
          remarkPlugins: [
            [
              require('@robertwebbmodular/remark-plugin-npm2yarn'),
              {sync: true},
            ],
          ],
        },
        pages: {
          // ...
          remarkPlugins: [
            [
              require('@robertwebbmodular/remark-plugin-npm2yarn'),
              {sync: true},
            ],
          ],
        },
        // ...
      },
    ],
  ],
  // ...
};

Options

Custom converters

In case you want to convert npm commands to something else than yarn or pnpm, you can use custom converters:

type CustomConverter = [name: string, cb: (npmCode: string) => string];

{
  remarkPlugins: [
    [
      require('@robertwebbmodular/remark-plugin-npm2yarn'),
      {
        sync: true,
        converters: [
          'yarn',
          'pnpm',
          ['Turbo', (code) => code.replace(/npm/g, 'turbo')],
        ],
      },
    ],
  ];
}