跳到主要内容

安装常用插件

docusaurus-plugin-sass​

要想使用 sass 格式 (.scss) 来写样式表就需要安装此插件。

安装方法：

npm install --save docusaurus-plugin-sass sass

在 docusaurus.config.js 中添加插件名称：

docusaurus.config.js
  plugins: [
    'docusaurus-plugin-sass'
  ],

参考官方文档：https://docusaurus.io/zh-CN/docs/styling-layout#sassscss

docusaurus-plugin-zooming​

单击图片放大插件。

安装：

npm install --save docusaurus-plugin-zooming

在 docusaurus.config.js 中添加插件名称：

docusaurus.config.js
  plugins: [
    'docusaurus-plugin-zooming'
  ],

然后就可以了。

项目地址: https://github.com/inovector/docusaurus-plugin-zooming

plugin-pwa​

用于将网页安装成本地应用 (需浏览器支持):

安装后在程序列表中就可以直接以应用的形式打开本网站了。

安装插件:

npm install --save @docusaurus/plugin-pwa

如果你用的 docusaurus 是 next 版本，就这样安装：

npm install --save @docusaurus/plugin-pwa@next

创建PWA manifest:

./static/manifest.json
{
  "name": "roc 云原生",
  "short_name": "roc 云原生",
  "theme_color": "#12affa",
  "background_color": "#424242",
  "display": "standalone",
  "scope": "/",
  "start_url": "/",
  "related_applications": [
    {
      "platform": "webapp",
      "url": "https://imroc.cc/manifest.json"
    }
  ],
  "icons": [
    {
      "src": "img/logo-32.pnag",
      "sizes": "32x32",
      "type": "image/png"
    },
    {
      "src": "img/logo-128.png",
      "sizes": "128x128",
      "type": "image/png"
    },
    {
      "src": "img/logo-192.png",
      "sizes": "192x192",
      "type": "image/png"
    },
    {
      "src": "img/logo-512.png",
      "sizes": "512x512",
      "type": "image/png"
    }
  ]
}

在 docusaurus.config.js 中添加插件配置：

docusaurus.config.js
  plugins: [
    [
      '@docusaurus/plugin-pwa',
      {
        debug: true,
        offlineModeActivationStrategies: [
          'appInstalled',
          'standalone',
          'queryString',
        ],
        pwaHead: [
          { tagName: 'link', rel: 'icon', href: '/img/logo.png' },
          { tagName: 'link', rel: 'manifest', href: '/manifest.json' },
          { tagName: 'meta', name: 'theme-color', content: '#12affa' },
        ],
      },
    ],
  ],

参考官方文档: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-pwa

remark-plugin-npm2yarn​

将 npm install 的命令自动转换为 yarn 和 pnpm 的等效命令，方便不同环境和安装偏好的人使用。

安装插件：

npm install @docusaurus/remark-plugin-npm2yarn

如果你用的 docusaurus 是 next 版本，就这样安装：

npm install @docusaurus/remark-plugin-npm2yarn@next

命令展示效果也如上所示

信息

参考 官方文档