feat(docs): update examples and enhance language support in configuration

This commit is contained in:
catlog22
2026-02-28 17:40:48 +08:00
parent 5e35da32e8
commit 39bbf960c2
2 changed files with 32 additions and 18 deletions

View File

@@ -254,14 +254,24 @@ export default defineConfig({
}, },
languages: [ languages: [
'bash', 'bash',
'shell',
'powershell', 'powershell',
'json', 'json',
'yaml', 'yaml',
'toml', 'toml',
'javascript', 'javascript',
'typescript', 'typescript',
'jsx',
'tsx',
'vue', 'vue',
'markdown' 'html',
'css',
'markdown',
'python',
'ruby',
'diff',
'xml',
'mermaid'
], ],
config: (md) => { config: (md) => {
// Add markdown-it plugins if needed // Add markdown-it plugins if needed

View File

@@ -2,6 +2,8 @@
This page provides practical examples of CCW workflow artifacts with sensitive information redacted. This page provides practical examples of CCW workflow artifacts with sensitive information redacted.
<div v-pre>
## Example 1: Lite Plan Output ## Example 1: Lite Plan Output
### plan.json ### plan.json
@@ -261,13 +263,13 @@ This is an output from `issue:execute` command.
### review-report.md ### review-report.md
This is an output from `review-code` skill. This is an output from `review-code` skill.
```markdown ```text
## Code Review Report ## Code Review Report
### Summary ### Summary
- **Review Type**: 6-Dimensional code review - Review Type: 6-Dimensional code review
- **Scope**: All files changed in PR #42 - Scope: All files changed in PR #42
- **Timestamp**: 2026-02-28 - Timestamp: 2026-02-28
### 1. Correctness ### 1. Correctness
| Aspect | Score | Issues | | Aspect | Score | Issues |
@@ -291,9 +293,9 @@ This is an output from `review-code` skill.
### Overall Score: 8.4/10 ### Overall Score: 8.4/10
### Recommendations ### Recommendations
1. **Performance**: Review bundle size 1. Performance: Review bundle size
2. **Performance**: Optimize database queries 2. Performance: Optimize database queries
3. **Maintainability**: Add JSDoc comments 3. Maintainability: Add JSDoc comments
``` ```
--- ---
@@ -303,23 +305,23 @@ This is an output from `review-code` skill.
### spec-section.md ### spec-section.md
This is an output from `spec-generator` skill. This is an output from `spec-generator` skill.
```markdown ```text
## API: User Authentication ## API: User Authentication
### Endpoint: POST /api/auth/login ### Endpoint: POST /api/auth/login
- **Description**: Authenticate user with email and password - Description: Authenticate user with email and password
- **Request**: { "email": "string", "password": "string" } - Request: { "email": "string", "password": "string" }
- **Response**: { "success": true, "token": "jwt_token", "user": {...} } - Response: { "success": true, "token": "jwt_token", "user": {...} }
### Endpoint: POST /api/auth/oauth2/callback ### Endpoint: POST /api/auth/oauth2/callback
- **Description**: Handle OAuth2 provider callback - Description: Handle OAuth2 provider callback
- **Request**: { "code": "string", "provider": "string", "state": "string" } - Request: { "code": "string", "provider": "string", "state": "string" }
- **Response**: { "success": true, "token": "jwt_token", "user": {...} } - Response: { "success": true, "token": "jwt_token", "user": {...} }
### Endpoint: POST /api/auth/logout ### Endpoint: POST /api/auth/logout
- **Description**: Logout user and invalidate token - Description: Logout user and invalidate token
- **Headers**: Authorization: Bearer token - Headers: Authorization: Bearer token
- **Response**: { "success": true, "message": "Logged out" } - Response: { "success": true, "message": "Logged out" }
### Error Codes ### Error Codes
| Code | Description | | Code | Description |
@@ -375,6 +377,8 @@ examples:
output: "Created auth-api.md with 5 endpoints" output: "Created auth-api.md with 5 endpoints"
``` ```
</div>
--- ---
## Using These Examples ## Using These Examples