Apache ShenYu 官方网站项目教程

1. 项目的目录结构及介绍

Apache ShenYu 官方网站项目的目录结构如下：

shenyu-website/
├── babel.config.js
├── docusaurus.config.js
├── package.json
├── sidebars.js
├── sidebarsCommunity.js
├── versions.json
├── docs/
├── src/
│   ├── components/
│   ├── css/
│   ├── pages/
│   └── theme/
├── static/
│   └── img/
└── versioned_docs/
    └── version-1.0/

目录结构介绍

• babel.config.js: Babel 配置文件，用于转换 JavaScript 代码。
• docusaurus.config.js: Docusaurus 配置文件，用于配置网站的基本信息和行为。
• package.json: 项目依赖和脚本配置文件。
• sidebars.js 和 sidebarsCommunity.js: 文档侧边栏配置文件。
• versions.json: 版本信息文件。
• docs/: 存放文档内容的目录。
• src/: 存放源代码的目录，包括组件、样式、页面和主题。
• static/: 存放静态资源的目录，如图片。
• versioned_docs/: 存放不同版本文档的目录。

2. 项目的启动文件介绍

项目的启动文件主要是 package.json 中的脚本配置。以下是一些关键的启动脚本：

{
  "scripts": {
    "start": "docusaurus start",
    "build": "docusaurus build",
    "swizzle": "docusaurus swizzle",
    "deploy": "docusaurus deploy",
    "clear": "docusaurus clear",
    "serve": "docusaurus serve",
    "write-translations": "docusaurus write-translations",
    "write-heading-ids": "docusaurus write-heading-ids"
  }
}

启动脚本介绍

• start: 启动开发服务器。
• build: 构建生产环境的静态网站。
• swizzle: 自定义 Docusaurus 组件。
• deploy: 部署网站。
• clear: 清除缓存。
• serve: 本地预览构建后的网站。
• write-translations: 生成翻译文件。
• write-heading-ids: 生成文档标题的 ID。

3. 项目的配置文件介绍

项目的配置文件主要包括 docusaurus.config.js 和 package.json。

docusaurus.config.js

docusaurus.config.js 是 Docusaurus 的主要配置文件，包含网站的基本信息和行为配置。以下是部分配置示例：

module.exports = {
  title: 'Apache ShenYu',
  tagline: 'High-performance multi-protocol extensible responsive API Gateway',
  url: 'https://shenyu.apache.org',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.ico',
  organizationName: 'apache',
  projectName: 'shenyu-website',
  themeConfig: {
    navbar: {
      title: 'Apache ShenYu',
      logo: {
        alt: 'Apache ShenYu Logo',
        src: 'img/logo.svg',
      },
      items: [
        {
          to: 'docs/',
          activeBasePath: 'docs',
          label: 'Docs',
          position: 'left',
        },
        {to: 'blog', label: 'Blog', position: 'left'},
        {
          href: 'https://github.com/apache/shenyu',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Docs',
          items: [
            {
              label: 'Getting Started',
              to: 'docs/',
            },
          ],
        },
        {
          title: 'Community',
          items: [
            {
              label: '