Skip to content

Commit ecfe4c7

Browse files
PreRelease: README update
1 parent 2a18d2d commit ecfe4c7

4 files changed

Lines changed: 65 additions & 357 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,17 @@ void process_data(std::span<const uint32_t> data) {
128128
在提交前,建议本地预览文档:
129129
130130
```bash
131-
# 安装依赖(创建虚拟环境并安装)
132-
./scripts/mkdocs_dev.sh install
131+
# 安装依赖
132+
pnpm install
133133
134-
# 启动本地服务器
135-
./scripts/mkdocs_dev.sh serve
134+
# 构建后预览(更接近生产环境效果)
135+
# 并发构建加速,建议值填写您的nproc输出结果
136+
BUILD_CONCURRENCY=16 pnpm build && pnpm preview
137+
# 到这里,会提示您访问 http://localhost:5173/Tutorial_AwesomeModernCPP/
136138
137-
# 访问 http://127.0.0.1:8000
139+
# 或者:启动开发服务器(支持热更新),调试构建用这个
140+
pnpm dev
141+
# 访问 http://localhost:5173/Tutorial_AwesomeModernCPP/
138142
```
139143

140144
## 代码审查流程

README.en.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
- **9-Volume System** -- From C crash course to embedded practice, forming a complete learning loop
2323
- **Compilable Examples** -- Every concept comes with a CMake project, not isolated code snippets
24-
- **Embedded Practice** -- STM32 / ESP32 / RP2040 multi-platform real hardware projects
24+
- **Embedded Practice** -- STM32 multi-platform real hardware projects
2525
- **Tag Navigation** -- Browse articles by topic, C++ standard, difficulty, and platform
2626
- **Online Reading** -- Full-featured documentation site with search, navigation, and dark mode
2727

@@ -94,28 +94,33 @@ flowchart TD
9494
```bash
9595
git clone https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP.git
9696
cd Tutorial_AwesomeModernCPP
97-
./scripts/mkdocs_dev.sh install # Create venv and install dependencies
98-
./scripts/mkdocs_dev.sh serve # Build and start local preview
99-
# Visit http://127.0.0.1:8000
97+
pnpm install # Install dependencies
98+
99+
# Build and preview (closer to production behavior)
100+
# Set BUILD_CONCURRENCY to your nproc output for faster parallel builds
101+
BUILD_CONCURRENCY=16 pnpm build && pnpm preview
102+
# Visit http://localhost:5173/Tutorial_AwesomeModernCPP/
103+
104+
# Or: start the dev server (with hot-reload) for debugging
105+
pnpm dev
106+
# Visit http://localhost:5173/Tutorial_AwesomeModernCPP/
100107
```
101108

102109
<details>
103-
<summary>More developer tools</summary>
104-
105-
| Script | Purpose |
106-
|------|------|
107-
| `mkdocs_dev.sh install` | Create virtual environment and install MkDocs dependencies |
108-
| `mkdocs_dev.sh serve` | Build and start local preview server |
109-
| `mkdocs_dev.sh build` | Production static site build |
110-
| `mkdocs_dev.sh clean` | Clean build artifacts |
111-
| `mkdocs_dev.sh reset` | Rebuild virtual environment from scratch |
112-
| `setup_precommit.sh` | Install pre-commit hooks |
113-
| `validate_frontmatter.py` | Validate article frontmatter |
114-
| `check_links.py` | Check internal link validity |
115-
| `check_nav_reachability.py` | Check chapter navigation completeness |
116-
| `analyze_frontmatter.py` | Analyze tutorial statistics |
117-
| `build_examples.py` | Compile all CMake example projects |
118-
| `check_quality.py` | Content quality checks |
110+
<summary>More commands and developer tools</summary>
111+
112+
| Command / Script | Purpose |
113+
|-------------|------|
114+
| `pnpm dev` | Start VitePress dev server (hot reload) |
115+
| `pnpm build` | Production build (parallel per-volume build + search index merge) |
116+
| `pnpm build:single` | Single build (no volume splitting) |
117+
| `pnpm preview` | Preview production build |
118+
| `scripts/setup_precommit.sh` | Install pre-commit hooks |
119+
| `scripts/validate_frontmatter.py` | Validate article frontmatter |
120+
| `scripts/check_links.py` | Check internal link validity |
121+
| `scripts/analyze_frontmatter.py` | Analyze tutorial statistics |
122+
| `scripts/build_examples.py` | Compile all CMake example projects |
123+
| `scripts/check_quality.py` | Content quality checks |
119124

120125
</details>
121126

@@ -165,9 +170,11 @@ Tutorial_AwesomeModernCPP/
165170
├── code/ # Example code
166171
│ ├── volumn_codes/vol1/ # Volume 1 code and exercises
167172
│ └── examples/ # Legacy code examples
173+
├── site/ # VitePress site configuration
174+
│ └── .vitepress/ # Config, theme, plugins
168175
├── scripts/ # Developer tool scripts
169176
├── todo/ # Content planning and progress tracking
170-
└── mkdocs.yml # MkDocs site configuration
177+
└── package.json # Node.js dependencies and build scripts
171178
```
172179

173180
</details>

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
- **9 卷体系** -- 从 C 语言速通到嵌入式实战,形成完整学习闭环
2727
- **可编译示例** -- 每个概念配 CMake 工程,不是孤立的代码片段
28-
- **嵌入式实战** -- STM32 / ESP32 / RP2040 多平台真机项目
28+
- **嵌入式实战** -- STM32 多平台真机项目
2929
- **标签导航** -- 按主题、C++ 标准、难度、平台多维检索
3030
- **在线阅读** -- 搜索、导航、暗色模式一应俱全的文档站
3131

@@ -98,28 +98,33 @@ flowchart TD
9898
```bash
9999
git clone https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP.git
100100
cd Tutorial_AwesomeModernCPP
101-
./scripts/mkdocs_dev.sh install # 创建虚拟环境并安装依赖
102-
./scripts/mkdocs_dev.sh serve # 构建并启动本地预览
103-
# 访问 http://127.0.0.1:8000
101+
pnpm install # 安装依赖
102+
103+
# 构建后预览(更接近生产环境效果)
104+
# 并发构建加速,建议值填写您的 nproc 输出结果
105+
BUILD_CONCURRENCY=16 pnpm build && pnpm preview
106+
# 访问 http://localhost:5173/Tutorial_AwesomeModernCPP/
107+
108+
# 或者:启动开发服务器(支持热更新),调试构建用这个
109+
pnpm dev
110+
# 访问 http://localhost:5173/Tutorial_AwesomeModernCPP/
104111
```
105112

106113
<details>
107-
<summary>更多开发工具</summary>
108-
109-
| 脚本 | 功能 |
110-
|------|------|
111-
| `mkdocs_dev.sh install` | 创建虚拟环境并安装 MkDocs 依赖 |
112-
| `mkdocs_dev.sh serve` | 构建并启动本地预览服务器 |
113-
| `mkdocs_dev.sh build` | 生产模式构建静态站点 |
114-
| `mkdocs_dev.sh clean` | 清理构建产物 |
115-
| `mkdocs_dev.sh reset` | 重建虚拟环境 |
116-
| `setup_precommit.sh` | 安装 pre-commit hooks |
117-
| `validate_frontmatter.py` | 验证文章 frontmatter |
118-
| `check_links.py` | 检查内部链接有效性 |
119-
| `check_nav_reachability.py` | 检查章节导航完整性 |
120-
| `analyze_frontmatter.py` | 分析教程统计信息 |
121-
| `build_examples.py` | 编译所有 CMake 示例项目 |
122-
| `check_quality.py` | 内容质量检查 |
114+
<summary>更多命令与开发工具</summary>
115+
116+
| 命令 / 脚本 | 功能 |
117+
|-------------|------|
118+
| `pnpm dev` | 启动 VitePress 开发服务器(热更新) |
119+
| `pnpm build` | 生产模式构建(分卷并行构建 + 搜索索引合并) |
120+
| `pnpm build:single` | 单体构建(不分卷) |
121+
| `pnpm preview` | 预览生产构建结果 |
122+
| `scripts/setup_precommit.sh` | 安装 pre-commit hooks |
123+
| `scripts/validate_frontmatter.py` | 验证文章 frontmatter |
124+
| `scripts/check_links.py` | 检查内部链接有效性 |
125+
| `scripts/analyze_frontmatter.py` | 分析教程统计信息 |
126+
| `scripts/build_examples.py` | 编译所有 CMake 示例项目 |
127+
| `scripts/check_quality.py` | 内容质量检查 |
123128

124129
</details>
125130

@@ -169,9 +174,11 @@ Tutorial_AwesomeModernCPP/
169174
├── code/ # 示例代码
170175
│ ├── volumn_codes/vol1/ # 卷一代码与练习
171176
│ └── examples/ # 历史代码示例
177+
├── site/ # VitePress 站点配置
178+
│ └── .vitepress/ # 配置、主题、插件
172179
├── scripts/ # 开发工具脚本
173180
├── todo/ # 内容规划与进度追踪
174-
└── mkdocs.yml # MkDocs 站点配置
181+
└── package.json # Node.js 依赖与构建脚本
175182
```
176183

177184
</details>

0 commit comments

Comments
 (0)