Documentation point to wrong `npm` package

[sharky98]

Hello, I wanted to try the plugin remark-plugin-import-file if it fit my use case. However, there seems to have a lot of discrepancies in this repository regarding this package. Probably due to the recent changes in namespace?

What is working

• NPM package page: https://www.npmjs.com/package/@rise4fun/docusaurus-remark-plugin-import-file
• pnpm add command: pnpm add @rise4fun/docusaurus-remark-plugin-import-file
  • I would assume it's the same for npm install and yarn add.

What is not aligned what is working

1. README.md

   • Source https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/packages/docusaurus-remark-plugin-import-file/README.md?plain=1#L3
   • Issue Looks like a typo in the package name? Word file is ending with a s, but the package isn't. https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/packages/docusaurus-remark-plugin-import-file/package.json#L2

2. Documentation

   • Source https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/website/docs/plugins/docusaurus-remark-plugin-import-file.mdx?plain=1#L5
   • Issue The title of the package in the docs (including elsewhere this title is reused by Docusaurus) does not match the package name. Looking at Docusaurus itself for their plugins, they just leave the scope (plugin-content-docs = @docusaurus/plugin-content-docs). Meaning, when reading the docs I assumed the package name was remark-plugin-import-file, plus whatever scope. But it is not!

3. Documentation

   • Source https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/website/docs/plugins/docusaurus-remark-plugin-import-file.mdx?plain=1#L18
   • Issue The npm package name shown in the command does not match either doc title or package itself.

Regards!

[sharky98]

Adding a fourth issue.

4. Documentation
   • Source https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/website/docs/plugins/docusaurus-remark-plugin-import-file.mdx?plain=1#L23-L32
   • Issue After trying to find out why this didn't import anything, I realized that this is not a Docusaurus plugin, but a remark plugin! It should instead be configured as per the Docusaurus remark plugins and not the Docusaurus plugins. Configuration should looks like this if using @docusaurus/preset-classic.

// highlight-start
const importFile = require("@rise4fun/docusaurus-remark-plugin-import-file");
// highlight-end

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          remarkPlugins: [
          ...,
          // highlight-start
            importFile
          // highlight-end
          ],
        },
      },
    ],
  ],
};

If using only the docs plugin without the preset, it should looks like this.

// highlight-start
const importFile = require("@rise4fun/docusaurus-remark-plugin-import-file");
// highlight-end

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-content-docs',
      /** @type {import("@docusaurus/plugin-content-docs").Options} */
      ({
        ...,
        remarkPlugins: [
          ...,
          // highlight-start
            importFile
          // highlight-end
          ],
      }),
    ],
  ],
};

[sharky98]

On a better note, once configured correctly, this plugin do works with my use case!!! 🎉🚀