🔵 other: Rename project and publish
This commit is contained in:
@@ -1,14 +1,13 @@
|
||||
# VDI WordPress Theme Starter v5
|
||||
# SoloFrame Evo
|
||||
|
||||
VDI WordPress Theme Starter v5 is a minimal WordPress theme designed as a starting point for custom theme development. It focuses on modern development approaches with a lean architecture that avoids the overhead of theme frameworks.
|
||||
SoloFrame Evo is a minimal WordPress theme designed as a starting point for custom theme development. It focuses on modern development approaches with a lean architecture that avoids the overhead of theme frameworks.
|
||||
|
||||
Repo: [https://github.com/Vincent-Design-Inc/VDI-Starter-v5](https://github.com/Vincent-Design-Inc/VDI-Starter-v5)
|
||||
AC Bug/Issue Tracking: [https://next-app.activecollab.com/119590/projects/4553?modal=Task-98192-4553](https://next-app.activecollab.com/119590/projects/4553?modal=Task-98192-4553)
|
||||
Repo: [https://github.com/ksolomon/SoloFrame-Evo](https://github.com/ksolomon/SoloFrame-Evo)
|
||||
|
||||
## Key Features
|
||||
|
||||
- Tailwind CSS v4 (CSS-first configuration, no `tailwind.config.js`)
|
||||
- Namespaced PHP (`BasicWP` namespace) for isolation
|
||||
- Namespaced PHP (`SoloFrameEvo` namespace) for isolation
|
||||
- Built-in support for ACF blocks with auto-registration
|
||||
- Fast development workflow with BrowserSync live reload
|
||||
- WordPress 6.5+ script modules for modern JS loading
|
||||
@@ -17,7 +16,7 @@ AC Bug/Issue Tracking: [https://next-app.activecollab.com/119590/projects/4553?m
|
||||
## Documentation
|
||||
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| ------- | ------------- |
|
||||
| [Getting Started](docs/getting-started.md) | Setup from zero, local WordPress, environment config, troubleshooting |
|
||||
| [Architecture](docs/architecture.md) | Bootstrap flow, layers, namespace conventions, hooks, enqueue system, theme.json |
|
||||
| [Creating Blocks](docs/creating-blocks.md) | Step-by-step ACF block creation tutorial with examples |
|
||||
@@ -25,26 +24,26 @@ AC Bug/Issue Tracking: [https://next-app.activecollab.com/119590/projects/4553?m
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
VDI-Starter-v5/
|
||||
├── acf/ # ACF field group JSON definitions
|
||||
```plain
|
||||
SoloFrame-Evo/
|
||||
├── acf/ # ACF/SCF field group JSON definitions
|
||||
├── bin/ # Build scripts (.build.js, .watch.js, .utils.js)
|
||||
├── content/ # Sample page and post content for testing
|
||||
├── docs/ # Documentation guides
|
||||
├── docs/ # Documentation guides
|
||||
├── lib/ # PHP library files
|
||||
│ ├── activation.php # Theme activation handler (plugins, pages, settings)
|
||||
│ ├── class-acf.php # ACF integration (JSON sync paths)
|
||||
│ ├── class-acf.php # ACF/SCF integration (JSON sync paths)
|
||||
│ ├── class-breadcrumbs.php # Breadcrumb generation with Schema.org markup
|
||||
│ ├── class-enqueue.php # Assets enqueuing (CSS, JS, fonts)
|
||||
│ ├── class-menuitems.php # Navigation menu builder
|
||||
│ ├── class-resources.php # Custom Resources post type
|
||||
│ ├── class-resources.php # Custom Resources post type
|
||||
│ ├── extras.php # Sidebar, page header, Owner role, embed wrapper
|
||||
│ ├── helpers.php # Utility functions and globals ($theme, $views)
|
||||
│ ├── hooks.php # WordPress hooks, filters, and cleanup
|
||||
│ ├── search-features.php # Enhanced search functionality
|
||||
│ └── show-template.php # Debug: shows active template in HTML comment
|
||||
├── static/
|
||||
│ ├── dist/ # Compiled assets (theme.css)
|
||||
│ ├── dist/ # Compiled assets (theme.css)
|
||||
│ └── js/ # JavaScript files
|
||||
│ ├── components/ # JS custom elements (button, backToTop)
|
||||
│ ├── modules/ # JS theme modules (Navigation, GetHeaderHeight, TagExternalLinks)
|
||||
@@ -58,10 +57,10 @@ VDI-Starter-v5/
|
||||
│ ├── fonts/ # Icon font styles (Lineicons)
|
||||
│ ├── navigation/ # Navigation styles (default, mega, accordion, sliding)
|
||||
│ └── theme.css # Main CSS entry point (Tailwind + imports)
|
||||
├── tests/ # Automated Playwright tests
|
||||
├── tests/ # Automated Playwright tests
|
||||
│ └── site-a11y.spec.js # Site Accessibility tests
|
||||
├── views/ # Template views
|
||||
│ ├── blocks/ # Custom ACF blocks (accordion, button, grid, section, etc.)
|
||||
├── views/ # Template views
|
||||
│ ├── blocks/ # Custom ACF/SCF blocks (accordion, button, grid, section, etc.)
|
||||
│ ├── icons/ # SVG icon templates
|
||||
│ ├── forms/ # Form templates (search)
|
||||
│ └── partials/ # Reusable template parts (page-hero, social-media)
|
||||
@@ -86,18 +85,18 @@ VDI-Starter-v5/
|
||||
The project uses several naming conventions. Here's how they relate:
|
||||
|
||||
| Convention | Value | Where Used |
|
||||
|-----------|-------|-----------|
|
||||
| PHP namespace | `BasicWP` | All PHP files |
|
||||
| Text domain | `basicwp` | WordPress translations |
|
||||
| Block category | `vdi-blocks` | Groups blocks in the editor |
|
||||
| Script module IDs | `basicwp-theme`, `basicwp-button`, `basicwp-admin` | JS module registration |
|
||||
| WP Engine folder | `vdi-v5` | Deployment target |
|
||||
| Theme directory | `VDI-Starter-v5` | Git repo name |
|
||||
| ----------- | ------- | ----------- |
|
||||
| PHP namespace | `SoloFrameEvo` | All PHP files |
|
||||
| Text domain | `sf-evo` | WordPress translations |
|
||||
| Block category | `sf-blocks` | Groups blocks in the editor |
|
||||
| Script module IDs | `sf-evo-theme`, `sf-evo-button`, `sf-evo-admin` | JS module registration |
|
||||
| WP Engine folder | `<change-me>>` | Deployment target |
|
||||
| Theme directory | `SoloFrame-Evo` | Git repo name |
|
||||
|
||||
## Included Blocks
|
||||
|
||||
| Block | Purpose |
|
||||
|-------|---------|
|
||||
| ------- | --------- |
|
||||
| Accordion | Collapsible content sections |
|
||||
| Buttons | Container for Button blocks |
|
||||
| Button | Configurable button element (`<x-button>` custom element) |
|
||||
@@ -124,7 +123,7 @@ The project uses several naming conventions. Here's how they relate:
|
||||
```
|
||||
|
||||
4. Copy `.env.example` to `.env` and set:
|
||||
- `LOCALHOST_URL`: Your local development URL (e.g., `http://localhost:1000`)
|
||||
- `LOCALHOST_URL`: Your local development URL (e.g., `http://site-dev.local`)
|
||||
- `BROWSERSYNC_PORT`: Port for BrowserSync (default: `5000`)
|
||||
|
||||
5. Run the initial build:
|
||||
|
||||
Reference in New Issue
Block a user