Skip to main
Table of Contents

Synticore Website Compiler Wiki

Synticore Website Compiler is a modular static-site build pipeline for HTML, CSS/SCSS, JavaScript, and media assets.

This wiki is aligned to the current compiler release: v1.1.0.


🧭 What Synticore Does

  • Builds project files from in/ to out/
  • Processes and minifies HTML, stylesheets, JavaScript, and media
  • Generates brand/favicons from project brand assets
  • Supports mirror copy rules for extra files/folders
  • Provides live watch + browser reload workflow
  • Supports dependency-aware watch rebuilds (referenced-file changes can trigger dependent tasks)
  • Supports packaging build outputs into zip and/or directory formats
  • Includes a GUI for task execution and schema-driven config editing

📚 Core Guides

  1. Setup Guide
    Install dependencies, prepare environment, pick a project, and validate toolchain.

  2. GUI Guide
    Use the desktop app to select projects, run tasks, and edit config safely.

  3. Terminal Tasks
    Full task reference with common workflows and maintenance commands.

  4. Configuration Reference
    Complete key-by-key configuration reference.


📎 Additional Guides

  1. Project Structure
    Folder/file layout, generated vs source content, and deletion safety.

  2. Migration Guide
    Version upgrade workflow, migration behavior, and migration task usage.

  3. Configuration Example
    Copy-ready practical snippets for common use cases.

  4. Log Guide
    Log file locations, debugging workflow, and incident capture checklist.

  5. Workflow
    Step-by-step operational flows for setup, dev, release, migration, and debugging.


🚀 Quick Start

From repository root:

npm install
pip install -r requirements.txt
python gui.py

or run terminal build directly:

npm run gulp build

📝 Notes

  • Source of truth for project config behavior lives in:
    • config/default/project/config.json
    • config/default/project/config.schema.json
  • Source of truth for task availability lives in gulpfile.js.
  • GUI task buttons are parsed from gulpfile.js, so task docs and GUI stay coupled to current task registrations.

Explore More

Home Download Wiki Report Issue License