easy-ngo-doc 项目使用教程

easy-ngo-doc 项目使用教程

easy-ngo-doc项目地址:https://gitcode.com/gh_mirrors/ea/easy-ngo-doc

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

easy-ngo-doc 项目的目录结构如下：

easy-ngo-doc/
├── docs/
├── src/
├── static/
├── github/workflows/
├── .gitignore
├── LICENSE
├── README.md
├── babel.config.js
├── docusaurus.config.js
├── package-lock.json
├── package.json
└── sidebars.js

目录结构介绍

• docs/: 存放项目文档的目录。
• src/: 存放源代码的目录。
• static/: 存放静态资源的目录。
• github/workflows/: 存放 GitHub Actions 工作流的目录。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• babel.config.js: Babel 配置文件。
• docusaurus.config.js: Docusaurus 配置文件。
• package-lock.json: 锁定依赖版本的文件。
• package.json: 项目依赖和脚本配置文件。
• sidebars.js: 文档侧边栏配置文件。

2. 项目的启动文件介绍

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

{
  "scripts": {
    "start": "docusaurus start",
    "build": "docusaurus build"
  }
}

启动命令介绍

• yarn start: 启动本地开发服务器，并打开浏览器窗口。大多数更改会实时反映，无需重启服务器。
• yarn build: 构建项目，生成静态文件。

3. 项目的配置文件介绍

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

docusaurus.config.js

docusaurus.config.js 是 Docusaurus 的主要配置文件，包含网站的元数据、插件配置、主题配置等。

module.exports = {
  title: 'My Site',
  tagline: 'Dinosaurs are cool',
  url: 'https://your-docusaurus-test-site.com',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.ico',
  organizationName: 'facebook', // Usually your GitHub org/user name.
  projectName: 'docusaurus', // Usually your repo name.
  themeConfig: {
    navbar: {
      title: 'My Site',
      logo: {
        alt: 'My Site Logo',
        src: 'img/logo.svg',
      },
      items: [
        {
          to: 'docs/',
          activeBasePath: 'docs',
          label: 'Docs',
          position: 'left',
        },
        {to: 'blog', label: 'Blog', position: 'left'},
        {
          href: 'https://github.com/facebook/docusaurus',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Docs',
          items: [
            {
              label: 'Style Guide',
              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/facebook/

easy-ngo-doc项目地址:https://gitcode.com/gh_mirrors/ea/easy-ngo-doc