You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Add local documentation build options to README
- Add "Build Documentation Locally" section in For Contributors
- Recommend BUILD_DOCS_MANUAL.md as the simple method
- Mark ACT_LOCAL_GITHUB_ACTIONS.md as optional advanced option
- Reorganize Documentation section with clear categorization
- Emphasize that documentation building is completely optional
> ⚠️ **Optional Feature:** Building documentation locally is **completely optional**. Core LeetCode practice functionality works without any documentation build setup.
1034
+
1035
+
**Recommended Method (Simple):**
1036
+
1037
+
The easiest way to build documentation locally is using the manual scripts:
1038
+
1039
+
```bash
1040
+
# Windows
1041
+
scripts\build_docs.bat
1042
+
1043
+
# Linux/macOS
1044
+
./scripts/build_docs.sh
1045
+
1046
+
# Build and preview locally
1047
+
scripts\build_docs.bat --serve # Windows
1048
+
./scripts/build_docs.sh --serve # Linux/macOS
1049
+
```
1050
+
1051
+
📖 **See [Building Documentation Locally (Manual Method)](docs/BUILD_DOCS_MANUAL.md)** for complete guide.
1052
+
1053
+
**Advanced Option (Optional):**
1054
+
1055
+
If you want to test the exact GitHub Actions workflow locally, you can use `act`:
1056
+
1057
+
📖 **See [Running GitHub Actions Locally with Act](docs/ACT_LOCAL_GITHUB_ACTIONS.md)** — *Note: Requires Docker and act tool. Only needed if you want to test CI/CD workflows.*
0 commit comments