https://github.com/zaidnizam/onyx
A versatile WordPress theme development starter kit leveraging React, TypeScript, and Tailwind CSS. This Builder Palette provides developers with a robust foundation to quickly build custom, responsive WordPress themes with modern web technologies.
https://github.com/zaidnizam/onyx
custom-blocks gutenberg-ready modern-workflow react responsive-design tailwindcss theme-development typescript webpack wordpress-jsx wordpress-theme-starter
Last synced: 3 months ago
JSON representation
A versatile WordPress theme development starter kit leveraging React, TypeScript, and Tailwind CSS. This Builder Palette provides developers with a robust foundation to quickly build custom, responsive WordPress themes with modern web technologies.
- Host: GitHub
- URL: https://github.com/zaidnizam/onyx
- Owner: zaidnizam
- Created: 2025-02-02T03:23:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-02T03:31:47.000Z (over 1 year ago)
- Last Synced: 2025-04-05T18:52:29.501Z (over 1 year ago)
- Topics: custom-blocks, gutenberg-ready, modern-workflow, react, responsive-design, tailwindcss, theme-development, typescript, webpack, wordpress-jsx, wordpress-theme-starter
- Language: JavaScript
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A versatile WordPress theme development starter kit leveraging React, TypeScript, and Tailwind CSS. This Builder Palette provides developers with a robust foundation to quickly build custom, responsive WordPress themes with modern web technologies.
Guide to use:
1. Clone the repository:
```bash
git clone https://github.com/zaidnizam/Onyx.git your-theme-name
cd your-theme-name
```
2. Ensure you have Node.js installed (version 16 or later):
```bash
node --version
```
3. Install dependencies:
```bash
npm install
```
4. Copy your theme folder into WordPress:
- Navigate to your WordPress installation
- Place the entire 'your-theme-name' folder into wp-content/themes/
5. Activate the theme in WordPress admin panel.
6. Start development:
```bash
npm run start
```
7. Customize your theme:
- Edit TSX files in src/ to create your theme structure and components
- Utilize Tailwind CSS for styling
- Modify tailwind.config.js for custom design tokens
8. Build for production:
```bash
npm run build
```
9. Your custom theme is now ready to use!
Note: This Builder Palette requires Node.js version 16 or later. Ensure your development environment meets this requirement before starting.