Syonext Logo
syonext
Login

Syonext Documentation

Learn how to build framework-agnostic content schemas using pure YAML, sync them via CLI, and deploy white-labeled client portals.

Quick Start

Get up and running with the Syonext CLI in seconds. The CLI is your bridge between your local codebase and your Syonext Agency Hub.

Terminal
npm install syonext-cli -g
syonext init my-new-project
cd my-new-project

Static vs. Dynamic Pages

Syonext determines your content structure entirely through your file naming conventions. No dashboard configuration required.

Static Pages

Standard YAML files define single, static pages (e.g., an About page or Homepage). The end user can edit the content, but cannot create duplicate pages from this schema.

about.data.yml
title: "About Our Agency" subtitle: "Built for speed." description: "We build high-performance web experiences."

Dynamic Blueprints (Templates)

Prefixing a file with an underscore (_) turns it into a blueprint. The client portal will use this schema to allow end-users to generate infinite items of this type (e.g., Blog posts, Case studies).

_blog.data.yml
title: "Post Title Placeholder" author: "Author Name" date: "YYYY-MM-DD" tags: ["Category 1", "Category 2"]

Rich Text Configuration

Need a full WYSIWYG editor for your client? Simply append the _config block to any text field in your YAML file. The Syonext portal will automatically render a premium rich-text editor for that field.

_blog.data.yml
content: _config: richText: true placeholder: "Write something awesome..."

CLI Commands

Keep your local code perfectly synchronized with the database.

  • syonext run

    Runs a single execution to parse your YAML files and push the schema to your Syonext project database.

  • syonext watch

    Watches your local directory for changes. Every time you save a `.data.yml` file, the schema is instantly updated in the cloud.

Agency Handover

Once your schemas are synced, you manage the data pipeline from your centralized Agency Hub.

  1. Log into your Agency Hub at app.syonext.com (or your custom domain).
  2. Review the synced data schemas.
  3. Configure client permissions and set your pricing markup.
  4. Click Push to generate the live client portal at portal.syonext.com (or your client's custom domain).