Apache CloudStack 项目教程

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

Apache CloudStack 项目的目录结构如下：

cloudstack-www/
├── docs/
├── src/
│   ├── components/
│   ├── pages/
│   ├── styles/
│   └── templates/
├── static/
├── docusaurus.config.js
├── package.json
└── yarn.lock

目录结构介绍

• docs/: 存放项目文档的目录。
• src/: 源代码目录，包含组件、页面、样式和模板。
  • components/: 存放React组件。
  • pages/: 存放页面文件。
  • styles/: 存放样式文件。
  • templates/: 存放模板文件。
• static/: 存放静态资源文件，如图片、字体等。
• docusaurus.config.js: 项目的配置文件。
• package.json: 项目的依赖管理文件。
• yarn.lock: 锁定依赖版本的文件。

2. 项目的启动文件介绍

项目的启动文件主要是 docusaurus.config.js 和 package.json。

docusaurus.config.js

docusaurus.config.js 是 Docusaurus 2 的配置文件，包含了网站的配置信息，如标题、描述、导航栏、插件等。

module.exports = {
  title: 'Apache CloudStack',
  tagline: 'Open-Source Cloud Computing Platform',
  url: 'https://cloudstack.apache.org',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.ico',
  organizationName: 'apache',
  projectName: 'cloudstack-www',
  themeConfig: {
    navbar: {
      title: 'Apache CloudStack',
      logo: {
        alt: 'Apache CloudStack 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/cloudstack-www',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Docs',
          items: [
            {
              label: 'Documentation',
              to: 'docs/',
            },
          ],
        },
        {
          title: 'Community',
          items: [
            {
              label: 'Stack Overflow',
              href: 'https://stackoverflow.com/questions/tagged/docusaurus',
            },
            {
              label: 'Discord',
              href: 'https://discordapp.com/invite/docusaurus',
            },
            {
              label: 'Twitter',
              href: 'https://twitter.com/docusaurus',
            },
          ],
        },
        {
          title: 'More',
          items: [
            {
              label: 'Blog',
              to: 'blog',
            },
            {
              label: 'GitHub',
              href: 'https://github.com/apache/cloudstack-www',
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} Apache CloudStack. Built with Docusaurus.`,
    },
  },
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          editUrl:
            'https://github.com/apache/cloudstack-www/edit/main/',
        },
        blog: {
          showReadingTime: true,
          editUrl:
            'https://github.com/apache/cloudstack-www/edit/main/blog/',
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      },
    ],