Add documentation

.github/workflows/deploy-docs.yml

@@ -0,0 +1,66 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
+      #   with:
+      #     version: 9 # Not needed if you've set "packageManager" in package.json
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,2 +1,7 @@
+# Composer Dependencies
 /vendor
 /composer.lock
+
+# Node Dependencies
+/package-lock.json
+node_modules

docs/.vitepress/.gitignore

@@ -0,0 +1,2 @@
+cache/*
+dist/*

docs/.vitepress/config.mts

@@ -0,0 +1,35 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "WordPress Theme Framework - Documentation",
+  description: "Documentation for Creode's WordPress Theme Framework.",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Installation', link: '/installation' },
+    ],
+
+    sidebar: [
+      {
+        text: 'Setup',
+        items: [
+          { text: 'Introduction', link: '/' },
+          { text: 'Installation', link: '/installation' },
+          { text: 'Migrating from Theme Core', link: '/migrating-from-theme-core' }
+        ]
+      },
+      {
+        text: 'Commands',
+        items: [
+          { text: 'Commands', link: '/commands' }
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+    ]
+  }
+})

docs/commands.md

@@ -0,0 +1,8 @@
+# Commands
+This plugin comes with a number of commands to help you manage your theme.
+
+## `wp creode-theme:install`
+Installs the Creode WordPress Framework files into your active theme (or a theme of your choice).
+
+## `wp creode-theme:build`
+Builds the assets for all active themes (or a theme of your choice).

docs/index.md

@@ -0,0 +1,24 @@
+---
+outline: deep
+---
+
+# Introduction
+This project is a simple WordPress plugin containing the Creode WordPress Theme Framework.
+
+## Plugin Features
+This plugin provides a simple way to install the Creode WordPress Theme Framework. It contains functionality that will allow for the simple compilation and handling of assets. It can facilitate the following:
+
+- Installation of the Creode WordPress Theme Framework
+- Compilation of assets
+- Providing a simple way to keep track of theme framework files and give a single location to manage SCSS and theme related files.
+- Allow the sharing of new theme files and systems across multiple themes.
+
+## Commands
+This plugin provides a number of commands. These are associated with the syncronisation of theme framework files and the compilation of assets. You can find more details on these commands in the [commands](/commands) section.
+
+## Upgrades from Theme Core
+The theme core was a small framework that initially handled the compilation of assets and the enqueueing of scripts and styles. It was a small framework that was not designed to be used as a base for themes. Details of this can be found in the [repository](https://github.com/creode/wordpress-theme-core).
+
+This package is designed to replace the theme core and provide a more robust framework for themes.
+
+A guide on upgrading your theme from the theme core to the new framework can be found in the [migrating from theme core](/migrating-from-theme-core) section.

docs/installation.md

@@ -0,0 +1,19 @@
+---
+outline: deep
+---
+
+# Installation
+
+## Composer (recommended)
+Installing the plugin via composer will automatically create the loader for you and add to the mu-plugins directory of your WordPress installation. Ensure your composer paths are set correctly for your WordPress installation.
+
+```bash
+composer require creode/wordpress-theme
+```
+
+## Manual
+
+1. Download the plugin from the [Creode WordPress Theme Framework GitHub repository](https://github.com/creode/wordpress-theme).
+2. Upload the plugin to your WordPress mu-plugins directory.
+3. Create the loader (steps to follow #TODO).
+3. Activate the plugin.

docs/migrating-from-theme-core.md

@@ -0,0 +1,199 @@
+---
+outline: deep
+---
+
+# Migrating from Theme Core
+
+## Introduction
+This guide will walk you through the process of migrating from the [theme core repository](https://github.com/creode/wordpress-theme-core) to the new framework.
+
+## Upgrade Steps
+
+### 1: Ensure you have all composer packages updated
+Run the following command to ensure you have all the latest packages installed.
+
+```bash
+composer update
+```
+
+### 2: Install the Creode WordPress Theme Framework
+
+Follow the [installation guide](/installation) to install the Creode WordPress Theme Framework.
+
+### 3: Remove the theme core from your project
+Using composer, remove the theme core from your project.
+
+```bash
+composer remove creode/theme-core
+```
+
+### 4: Remove the requirement of the theme-core boot file
+Remove the following line from your `functions.php` file.
+
+```php
+require_once get_template_directory() . '/core/boot.php'; // [!code --]
+```
+
+### 5: Replace class of register_vite_script function
+The assets class from theme core has been removed and instead is now replaced with a function from the new theme framework.
+
+You will need to replace all occurrences and function calls:
+```php
+use Creode_Theme\Asset_Enqueue; // [!code ++]
+
+function [[THEME_NAME]]_enqueue_script() {
+    Assets::register_vite_script( 'header', 'src/components/header.js', array( 'jquery' ), true );   // [!code --]
+
+    $asset_enqueue = Asset_Enqueue::get_instance(); // [!code ++]
+    $asset_enqueue->register_vite_script( 'header', 'src/components/header.js', array( 'jquery' ), true );  // [!code ++]
+
+    // ... other required code ...
+};
+add_action( 'wp_enqueue_scripts', '[[THEME_NAME]]_enqueue_script' );
+```
+
+This will now ensure that all JS is loaded from Vite correctly.
+
+### 6: Remove hot reloading from your vite config file.
+Hot reloading was a feature that was a little buggy on the theme core. It is therefore no longer supported in the new theme framework. There may be plans in future to reintroduce this feature.
+
+In order to remove hot reloading, you will need to remove the following line from your vite config file.
+
+```js
+import { manageHotReloadFile } from './core/js/hot-reload.js'; // [!code --]
+
+export default defineConfig(
+	(command) => {
+        manageHotReloadFile(command.mode, DDEV_HOSTNAME, HOT_RELOAD_PORT); // [!code --]
+
+        // ... other vite config code ...
+	}
+);
+```
+
+### 7: Move your SCSS folder up a level
+In the previous version of the theme core framework, the SCSS folder was located within the `src` folder. As part of this migration, you will need to move the SCSS folder up a level to the root of the project. The `SCSS` folder should now be located in the root of the theme.
+
+For example if you had a `src/scss` folder in the theme, it should now be moved to the root of the theme to `scss/`.
+
+### 8: Migrate the component specific CSS files up to the component directory
+As part of the changes to how blocks are handled, the SCSS files for each block should now be moved to their relevant block folder.
+
+For example a header.scss component file will now be located in the following folder based on the theme root: `/blocks/header-block/assets/header.scss`.
+
+Each of these components should be moved to their relevant block folder.
+
+This is a change that will need to be done manually and can be quite tedious however it will ensure that all themes and blocks are kept consistent in the future.
+
+### 9: Remove individual components imports from the `admin.scss` and `main.scss` files
+As part of the changes to how blocks are handled, the individual components `@use` and `@include` from the `admin.scss` and `main.scss` files are no longer required. These are now handled by the theme framework and will be automatically added to the theme in a new `blocks/_all.scss` file.
+
+This is a change that will need to be done manually and can be quite tedious however it will ensure that all themes and blocks are kept consistent in the future.
+
+You can recompile the assets to check over your changes periodically during this process by running the following WP CLI command:
+```bash
+wp creode-theme:build
+```
+
+### 10: Clean up scss import paths
+After moving the SCSS files to their relevant block folder, you will need to clean up the `@use` paths for each of the SCSS files. Paths to scss files in vite can be absolute based on where the `vite.config.js` file is located. In this case it will be in the theme.
+
+An example of this is demonstrated below with pulling the global file into the `header.scss` file:
+
+```scss
+@use "../globals"; // [!code --]
+@use "/scss/globals"; // [!code ++]
+```
+
+This change can be quite tedious to do manually however we want to ensure that all themes keep the same structure and paths so a change like this will help our projects stay consistent in the future.
+
+### 11: Run the script to install any framework files and compile assets
+As part of the theme framework, there is a WordPress CLI command that will install any missing files and compile the assets. This ensures that the structure of the theme is kept consistent and that new files as part of the boilerplate can be added automatically to themes without having to keep track of them manually.
+
+### 12: Remove the admin and main js files from src
+As part of the framework, the main.js and admin.js within the `src` folder are no longer required. These are now handled by the theme framework and will be automatically added to the theme in a new `vite-entry-points` folder. These files are no longer required and can be removed from the `src` folder, if there is more content to them, ensure this is now merged with the newly created equivalent files in the `vite-entry-points` folder.
+
+### 13: Update the vite config file to switch these entrypoints over
+The `vite.config.js` file will need to be updated to switch these entrypoints over to the new `vite-entry-points` folder.
+
+```js
+export default defineConfig(
+	(command) => {
+		return {
+            // ... other vite config code ...
+			build: {
+				rollupOptions: {
+					// overwrite default .html entry
+					input: {
+                        main: resolve(__dirname, 'src/main.js'), // [!code --]
+						admin: resolve(__dirname, 'src/admin.js'), // [!code --]
+                        main: resolve(__dirname, 'vite-entry-points/main.js'), // [!code ++]
+						admin: resolve(__dirname, 'vite-entry-points/admin.js'), // [!code ++]
+                        // ... other vite config code ...
+					}
+				}
+			}
+		}
+	}
+);
+```
+
+
+### 14: Import the new `blocks/_all.scss` file into the main.scss file
+Add the following to the top of the `main.scss` file:
+
+```scss
+// Use base elements
+@use 'base';
+
+// Use blocks  // [!code ++]
+@use '/blocks/all' as blocks; // [!code ++]
+
+// ...other scss code...
+
+// Render base elements
+@include base.render;
+
+// Render blocks  // [!code ++]
+@include blocks.render; // [!code ++]
+```
+
+This will ensure that all blocks are loaded into the theme.
+
+### 15: Import the new `blocks/_all.scss` file into the admin.scss file
+This process is very similar to the `main.scss` file however you will need to ensure that any admin specific mixins are handled manually using the new folder location. The new blocks all file only handle the render mixin and admin ones will need to be handled manually. See the below example for how this has changed:
+
+```scss
+@use 'components/header'; // [!code --]
+@use '/blocks/header-block/assets/_header' as header; // [!code ++]
+
+// ...other scss code...
+
+@include header.render; // [!code --]
+@include header.admin; // [!code ++]
+```
+
+Add the following to the `admin.scss` file:
+
+```scss
+// Use base elements
+@use 'base';
+
+// Use blocks
+@use '/blocks/all' as blocks; // [!code ++]
+
+// ...other scss code...
+
+// Render base elements
+@include base.render;
+
+// Render blocks // [!code ++]
+@include blocks.render; // [!code ++]
+```
+
+### 16: Recompile the assets
+Once these steps have been completed, you will need to recompile the assets. This can be done by running the following WP CLI command:
+
+```bash
+wp creode-theme:build
+```

package.json

@@ -0,0 +1,15 @@
+{
+  "name": "creode-wordpress-theme-framework",
+  "version": "1.0.0",
+  "description": "Creode's WordPress Theme Framework",
+  "author": "Creode",
+  "license": "MIT",
+  "devDependencies": {
+    "vitepress": "^1.6.4"
+  },
+  "scripts": {
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  }
+}