simpler-paper 使用教程

simpler-paper 使用教程

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

simpler-paper 项目的目录结构相对简单，主要包含以下几个部分：

simpler-paper/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── styles.css
│   └── ...
├── docs/
│   ├── 1_firstDoc.md
│   ├── assets/
│   │   └── image.png
│   └── ...
└── paper-config.json

• README.md: 项目说明文件，包含项目的基本介绍和使用方法。
• package.json: 项目的依赖管理文件，包含项目的依赖包和脚本命令。
• src/: 源代码目录，包含项目的核心代码和样式文件。
• docs/: 文档目录，包含需要生成的 Markdown 文件和资源文件。
• paper-config.json: 项目的配置文件，用于配置生成的文档网站的各种参数。

2. 项目的启动文件介绍

项目的启动文件主要是 src/index.js，它是整个项目的入口文件，负责初始化和启动文档生成服务。以下是 index.js 的主要功能：

• 读取 paper-config.json 配置文件。
• 解析 docs/ 目录下的 Markdown 文件。
• 生成文档网站的结构和内容。
• 启动本地预览服务器或部署到 GitHub Pages。

3. 项目的配置文件介绍

paper-config.json 是 simpler-paper 项目的配置文件，用于配置生成的文档网站的各种参数。以下是配置文件的主要内容和说明：

{
  "alias": {
    "quickstart": "Getting Started"
  },
  "title": "simpler paper",
  "minimap": true,
  "backToTop": true,
  "docPath": "/",
  "indicator": true
}

• alias: 文档别名配置，用于为文档设置别名，方便导航。
• title: 文档网站的标题。
• minimap: 是否在文档右侧生成迷你目录地图。
• backToTop: 是否显示返回至顶部的按钮。
• docPath: 文档的路径。
• indicator: 是否显示加载指示器。

通过配置 paper-config.json，可以灵活地调整生成的文档网站的外观和功能。