// 查看 create-docusaurus 有哪些选项参数
npx create-docusaurus@latest --help

// 新建一个 docusaurus2 项目命令
// Usage: create-docusaurus [siteName] [template] [rootDir] [options]

// 新建了 一个 docusaurus-blog 项目，使用了 classic 模板，使用 npm/yarn/pnpm 其中某一个包管理器 
npx create-docusaurus@latest 项目名称(如：docusaurus-blog) 使用的模版(如：classic) [根目录] -p npm/yarn/pnpm

// 使用 typescript
npx create-docusaurus@latest 项目名称(如：docusaurus-blog) 使用的模版(如：classic) [根目录] -p npm/yarn/pnpm --typescript

// 包管理工具使用 npm，默认值
npx create-docusaurus@latest docusaurus-blog classic -p npm

// 包管理工具使用 yarn
npx create-docusaurus@latest docusaurus-blog classic -p yarn

// docusaurs.config.js
module.exprots = {
  // ...
  presets: [
    [
      'classic',({
        docs: {
          // 修正 sidebars.js 的引用目录
          sidebarPath: require.resolve('./configs/sidebars.js'),
          editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
        },
        blog: {
          showReadingTime: true,
          editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],
}

module.exports = {
  // 必填字段
  title: '我的博客', // 网站标题
  url: 'https://xxx.github.io', // 网站网址，看作是顶级主机名 和 baseUrl 字段相关
  baseUrl: '/docusaurus-blog/', // 站点的 base URL,可以被看作是主机名后的路径

  // 选填字段
  favicon: '/images/logo.jpg',   // 网站图标的路径
  tagline: '这是使用 docusaurus2 搭建的个人文档系统', // 网站标语
  titelDelimiter: '|',           // 在生成的 title 标签中被用作标题分隔符, 默认 '|'
  // themes: ['@docusaurus/theme-classic'], // 主题插件，使用默认的主题不需要再配置中列出
  trailingSlash: undefined,      // 选项允许你自定义 URL / 链接后是否添加末尾斜杠 
  noIndex: true,                 // 搜索引擎是否要爬取站点, 默认：false
  onBrokenLinks: 'throw',        // 有效取值：'ignore' | 'log' | 'warn' | 'throw'
                                 // Docusaurus 在检测到无效链接时的行为，默认情况下会抛出错误，
                                 // 若保证发布的网站不会包括任何无效链接，可以按需调整，注：无效链接检测仅在生产构建中可用  
  i18n: {                        // 用于本地化站点的 i18n 配置对象
    defaultLocale: 'zh-Hans',    // en | zh-Hans
    locales: ['zh-Hans'],
  },
  themeConfig: { // 主题的配置，具体请查看：https://docusaurus.io/zh-CN/docs/api/themes/configuration
    // 下面单独说明
  },
}

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        // debug 默认为在开发环境中 true，而在生产环境中为 false
        debug: undefined,
        // 会被传递给 @docusaurus/theme-classic。
        theme: {
          customCss: [require.resolve('./src/css/custom.css')],
        },
        // 会被传递给 @docusaurus/plugin-content-docs（用 false 来禁用）
        docs: {

        },
        // 会被传递给 @docusaurus/plugin-content-blog（用false 来禁用）
        blog: {

        },
        // 会被传递给 @docusaurus/plugin-content-pages（用 false 来禁用）
        pages: {},
        // 会被传递给 @docusaurus/plugin-content-sitemap（用 false 来禁用）
        sitemap: {},
        // 会被传递给 @docusaurus/plugin-google-gtag （只在显式声明时才会被启用）
        gtag: {},
        // 会被传递给 @docusaurus/plugin-google-analytics（只在显式声明时才会被启用）
        googleAnalytics: {},
      },
    ],
  ],
};