Skip to main content
Squeditor forces a strict separation of concerns. The framework engine is completely isolated from the templates that consume it.

The Mental Model: Global vs Local

[workspace-root]
squeditor
my-project
another-project
Crucial Rule: The squeditor/ directory contains zero template content. Templates contain zero framework logic. Templates reference the framework only via config.framework: '../squeditor' in their config file. Never manually edit files inside the squeditor/ core folder while building a site.

A Look Inside a Project

When you scaffold a new template, your working environment (my-project/) handles data, uncompiled SCSS/PHP, and bundled output securely.

Workspace Breakdown

[workspace-root]
squeditor-framework
scripts
utils
build-components.js
snapshot.js
dev.js
uikit-manifest.json
my-project
squeditor.config.js
src
dist

The src vs dist Relationship

Everything you code happens in the src/ directory.
  • You write .php files in src/pages/.
  • You write .scss files in src/assets/scss/.
When you compile (npm run build), the framework:
  1. Compiles the SCSS to Tailwind.
  2. Boots up a local server.
  3. Visits every .php page you created.
  4. Downloads the output as flat .html files.
  5. Saves them perfectly structured inside dist/.
Never manually edit files inside dist/. They are overwritten every time you run a build.