AcWiKi 项目使用教程

AcWiKi 项目使用教程

AcWiKi 属于大学生群体的真·青年大学习 项目地址: https://gitcode.com/gh_mirrors/ac/AcWiKi

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

AcWiKi 项目的目录结构如下所示：

AcWiKi/
├── .github/
│   └── workflows/
├── docs/
├── src/
├── .autocorrectrc
├── .gitignore
├── .prettierignore
├── .prettierrc.yaml
├── CODE_OF_CONDUCT.md
├── CODE_OF_CONDUCT_en.md
├── LICENSE
├── mkdocs.yml
├── requirements.txt
└── README.md

• .github/workflows/：存放 GitHub Actions 工作流的配置文件，用于自动化处理如代码提交、发布等事件。
• docs/：存放项目文档的Markdown文件。
• src/：项目的主要代码目录。
• .autocorrectrc：自动更正配置文件。
• .gitignore：Git 忽略文件列表，指定 Git 应该忽略的文件和目录。
• .prettierignore：Prettier 忽略文件列表，指定 Prettier 格式化时应该忽略的文件和目录。
• .prettierrc.yaml：Prettier 配置文件，用于设置代码格式化的规则。
• CODE_OF_CONDUCT.md：项目行为准则文件，描述了贡献者的行为规范。
• CODE_OF_CONDUCT_en.md：项目行为准则文件的英文版。
• LICENSE：项目许可证文件，本项目采用 Apache-2.0 许可。
• mkdocs.yml：MkDocs 配置文件，用于配置生成文档的网站。
• requirements.txt：项目依赖文件，列出了项目运行所需的Python包。
• README.md：项目说明文件，提供了项目的基本信息和说明。

2. 项目的启动文件介绍

项目的启动主要是通过 mkdocs 命令来实现的。在项目根目录下，执行以下命令启动项目：

mkdocs serve

该命令会启动一个本地服务器，默认监听 8000 端口，用户可以通过浏览器访问 http://127.0.0.1:8000 来查看项目文档。

3. 项目的配置文件介绍

项目的配置主要通过 mkdocs.yml 文件来进行。以下是 mkdocs.yml 的基本配置说明：

site_name: AcWiKi
nav:
    - Home: index.md
    - Docs: documentation.md

• site_name：设置网站名称，这里设置为 "AcWiKi"。
• nav：定义导航栏的链接，其中 Home 指向 index.md 文件，Docs 指向 documentation.md 文件。

通过编辑 mkdocs.yml 文件，可以进一步自定义网站的主题、样式、导航链接等配置。

AcWiKi 属于大学生群体的真·青年大学习 项目地址: https://gitcode.com/gh_mirrors/ac/AcWiKi