@@ -29,18 +29,21 @@ A modern WordPress block theme supporting Full Site Editing (FSE), built with mu
2929### Development Installation
3030
31311 . Clone this repository:
32+
3233 ``` bash
3334 git clone {{theme_repo_url}}
3435 cd {{theme_slug}}
3536 ```
3637
37382 . Install dependencies:
39+
3840 ``` bash
3941 npm install
4042 composer install
4143 ```
4244
43453 . Build assets:
46+
4447 ``` bash
4548 npm run build
4649 ```
@@ -65,19 +68,55 @@ composer install
6568npm run start
6669```
6770
71+ ### Build Process
72+
73+ This theme uses ` @wordpress/scripts ` for a modern build workflow:
74+
75+ - ** Compilation** : Modern JavaScript (ESNext/JSX) → Browser-compatible code via Babel
76+ - ** Bundling** : Multiple files combined into optimized bundles via webpack
77+ - ** Sass Compilation** : ` .scss ` files compiled to standard CSS
78+ - ** Code Minification** : JavaScript (Terser) and CSS (cssnano) optimization
79+ - ** Code Linting** : ESLint for JavaScript, Stylelint for CSS
80+ - ** Code Formatting** : Prettier for consistent styling
81+
82+ ** Documentation** :
83+
84+ - 📖 [ Build Process Guide] ( docs/BUILD-PROCESS.md ) - Complete build documentation
85+ - 📖 [ wp-scripts Configuration] ( docs/WP-SCRIPTS-CONFIGURATION.md ) - Detailed setup guide
86+ - 📖 [ Quick Reference] ( docs/WP-SCRIPTS-QUICK-REFERENCE.md ) - Common tasks and commands
87+ - 📖 [ Summary] ( docs/WP-SCRIPTS-SUMMARY.md ) - Configuration summary
88+
6889### Available Scripts
6990
70- - ` npm run start ` - Start development mode with hot reloading
71- - ` npm run build ` - Build for production
72- - ` npm run build:production ` - Build optimized for production
73- - ` npm run lint ` - Run all linters
74- - ` npm run lint:js ` - Lint JavaScript
75- - ` npm run lint:css ` - Lint CSS
76- - ` npm run lint:php ` - Lint PHP
77- - ` npm run test ` - Run all tests
78- - ` npm run test:js ` - Run JavaScript tests
79- - ` npm run test:php ` - Run PHP tests
80- - ` npm run test:e2e ` - Run end-to-end tests
91+ #### Build Commands
92+
93+ - ` npm run start ` - Start development mode with hot reloading and watch mode
94+ - ` npm run build ` - Build optimized production assets
95+ - ` npm run build:production ` - Alternative production build
96+
97+ #### Code Quality
98+
99+ - ` npm run lint ` - Run all linters (JavaScript, CSS, PHP)
100+ - ` npm run lint:js ` - Lint JavaScript files
101+ - ` npm run lint:js:fix ` - Auto-fix JavaScript issues
102+ - ` npm run lint:css ` - Lint CSS/Sass files
103+ - ` npm run lint:css:fix ` - Auto-fix CSS issues
104+ - ` npm run lint:php ` - Lint PHP files
105+ - ` npm run format ` - Format all files with Prettier
106+
107+ #### Testing
108+
109+ - ` npm run test ` - Run all tests (JavaScript + PHP)
110+ - ` npm run test:js ` - Run JavaScript unit tests
111+ - ` npm run test:js:watch ` - Run Jest in watch mode
112+ - ` npm run test:php ` - Run PHP unit tests
113+ - ` npm run test:e2e ` - Run end-to-end tests with Playwright
114+
115+ #### Internationalization
116+
117+ - ` npm run makepot ` - Generate translation POT file
118+ - ` npm run makejson ` - Generate JSON translation files
119+ - ` npm run i18n ` - Complete i18n workflow (makepot + makejson)
81120
82121### Theme Structure
83122
@@ -124,6 +163,7 @@ This theme uses mustache templates for easy customization. Key variables include
124163### Customizing Colors and Typography
125164
126165Edit ` theme.json ` to customize:
166+
127167- Color palette
128168- Typography settings
129169- Spacing scale
@@ -158,6 +198,7 @@ Please read our [Contributing Guidelines](CONTRIBUTING.md) for more details.
158198## Support
159199
160200- Documentation: [ Full documentation] ( {{docs_url}} )
201+ - Internationalization: [ i18n Guide] ( docs/INTERNATIONALIZATION.md )
161202- Issues: [ GitHub Issues] ( {{theme_repo_url}}/issues )
162203- Community: [ WordPress.org Support] ( https://wordpress.org/support/theme/{{theme_slug}} )
163204
0 commit comments