首页 > 其他分享 >docusaurus默认访问地址前缀 以及多实例

docusaurus默认访问地址前缀 以及多实例

时间:2023-01-30 16:34:06浏览次数:40  
标签:docusaurus ... 前缀 实例 docs api config guide

前言

默认情况下 所有的md文档 都应该以docs为根目录。

you-project
 |--docs
    |--test.md

而访问路由 也是默认的http://localhost:3000/docs/test

如果觉得不好看 需要修改路由前缀 为http://localhost:3000/guide/test
则需要修改如下

const config = {
  ...
  presets: [
    [
      'classic',
      ({
        docs: {
          ...
          routeBasePath: "guide",
        },
        ...
      }),
    ],
  ],

多个实例下

修改配置文件docusaurus.config.js
可以根据如上只是 并且结合@docusaurus/plugin-content-docs来实现

you-project
 |--docs
    |--guide
      |--- 第一章.md
    |--- api
      |--- 第一章.md
const config = {
  ...
  plugins: [
...
  "@docusaurus/plugin-content-docs",
    {
      id: 'api-module',
      path: 'docs/api',
      routeBasePath: 'api',
      sidebarPath: require.resolve("./sidebars.js"),
    }
],
  presets: [
    [
      'classic',
      ({
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          path: "docs/guide",
          routeBasePath: "guide",
        },
        ...
      }),
    ],
  ]

};

module.exports = config;

如上 只是路由能够访问了 但如果需要配置到顶部菜单中 则还需要再配置文件中修改如下

themeConfig:
    ({
      ...
        items: [
          {
            type: 'doc',
            docId: '第1章_前言',
            label: '文档',
          },
          {
            docsPluginId: 'api-module',
            type: 'doc',
            docId: '第1章_前言',
            label: 'API',
          }
        ],
      },
      ...
    })

标签:docusaurus,...,前缀,实例,docs,api,config,guide
From: https://www.cnblogs.com/dingshaohua/p/17076367.html

相关文章

  • Qt应用程序使用OpenCV库测试视频捕捉实例程序源码
    intmain(){VideoCapturecap(0);if(!cap.isOpened()){return-1;}while(1){Matframe;cap>>frame;if(frame.......
  • eclipse + JDK + WTK安装使用及代码实例
    在网上看了好多关于eclipse与J2ME这个配置的文章,看了半天都没有弄个明白,也许是第一次接触,摸索的太慢。所以,自己整理了份可以使用的步骤出来。给以后能看到这篇文章的人提供......
  • Java I/O经典代码实例
    packageIO;importjava.io.*;publicclassFileDirectoryDemo{publicstaticvoidmain(String[]args){//如果没有指定参数,则缺省为当前目录。if(args.length==......
  • 浅谈Linux下file的应用实例
    file的官方解释为:file - determine file type也就是说可以识别文件类型的意思,也可用来辨别一些文件的编码格式。下面看几个比较使用的例子。实例一:默认file后......
  • 单实例Primary快速搭建Standby RAC参考手册(19.16 ADG)
    环境:SingleInstance->RACSingleInstance:db_name=demodb_unique_name=demoinstance_name=demoservice_names=demoRAC(2nodes):db_name=demodb_unique_name=d......
  • Linux下编写USB驱动实例
    USB是连接计算机系统与外部设备的一种串口总线标准,也是一种输入输出接口的技术规范,被广泛地应用于个人电脑和移动设备等信息通讯产品,USB就是简写,中文叫通用串行总线。我......
  • QPython实例01-获取所有短信并生成词云
    一、QPython安装配置1.1.QPython介绍QPython是一个可以在安卓设备运行python的脚本引擎。版本有QPython3L和QPython3C,3L为官方版本,可以在应用市场搜索下载。3C版本为"......
  • react组件实例属性props
    propsprops简单使用classPersonextendsReact.Component{render(){return(<ul>......
  • 高维前缀和
    普通求前缀和,是容斥意义下去做的而如果我们用这种思路带向高维,则其复杂度是\(O(n2^d)\,\,\,d\)是维数的高维前缀和可以做到\(O(nd)\)具体方法就是对每一位分别做前缀......
  • (AtCoder Beginner Contest 287)(D 字符串前后缀合并匹配)(E Trie求最长公共前缀(LCP)
    D-MatchorNot(字符串前后缀合并匹配)题目大意:给定两个字符串S和T,对于每个x=0,1,2...|T|求S的子串(前x个字符和后|T|-x个字符在不改变顺序的情况下组成)是否与T相......