|
21 | 21 |
|
22 | 22 | - **9-Volume System** -- From C crash course to embedded practice, forming a complete learning loop |
23 | 23 | - **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 |
25 | 25 | - **Tag Navigation** -- Browse articles by topic, C++ standard, difficulty, and platform |
26 | 26 | - **Online Reading** -- Full-featured documentation site with search, navigation, and dark mode |
27 | 27 |
|
@@ -94,28 +94,33 @@ flowchart TD |
94 | 94 | ```bash |
95 | 95 | git clone https://github.com/Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP.git |
96 | 96 | 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/ |
100 | 107 | ``` |
101 | 108 |
|
102 | 109 | <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 | |
119 | 124 |
|
120 | 125 | </details> |
121 | 126 |
|
@@ -165,9 +170,11 @@ Tutorial_AwesomeModernCPP/ |
165 | 170 | ├── code/ # Example code |
166 | 171 | │ ├── volumn_codes/vol1/ # Volume 1 code and exercises |
167 | 172 | │ └── examples/ # Legacy code examples |
| 173 | +├── site/ # VitePress site configuration |
| 174 | +│ └── .vitepress/ # Config, theme, plugins |
168 | 175 | ├── scripts/ # Developer tool scripts |
169 | 176 | ├── todo/ # Content planning and progress tracking |
170 | | -└── mkdocs.yml # MkDocs site configuration |
| 177 | +└── package.json # Node.js dependencies and build scripts |
171 | 178 | ``` |
172 | 179 |
|
173 | 180 | </details> |
|
0 commit comments