Skip to content
sigMAX logo SIGMAX Development Documentation v0.72 Secure Integrated Generator of Modular Architecture with execution Runtime
AdminRepository
About Documentation Contact
AdminRepository

FrontMark

FrontMark is the enriched Markdown layer used around sigMAX to publish documentation, examples, and lightweight frontend content. It keeps authoring close to Markdown while adding richer rendering patterns for pages that need more structure than plain prose.

In sigMAX, FrontMark is referenced as an associated frontend component, but it is a separate part of the project. This page keeps only the context needed from the sigMAX documentation and sends detailed usage, syntax, and implementation notes to the dedicated FrontMark space.

Open the detailed FrontMark space View the FrontMark repository

A small publishing layer, not another runtime

FrontMark gives sigMAX a concise way to turn Markdown into richer frontend documentation: readable source, structured rendering, visual callouts, and clear links back to the project pieces that own the actual behavior.

Role in sigMAX

Section titled “Role in sigMAX”

FrontMark provides a lightweight way to expose human-readable content around sigMAX without turning that content into a generated application frontend. It is useful for documentation pages, examples, tutorials, visual explanations, and small interactive documentation blocks.

Its role is deliberately narrow:

  • Publish enriched Markdown content for sigMAX-related pages.
  • Keep detailed syntax, examples, and implementation notes in the dedicated FrontMark space.
  • Let the frontend/documentation layer evolve separately from the sigMAX generator and runtime.
  • Preserve a low-friction writing workflow for technical content.

What FrontMark Adds

Section titled “What FrontMark Adds”

FrontMark starts from Markdown and adds a rendering layer for richer documentation patterns. The exact syntax reference lives in /frontmark, but the intent can be summarized from the sigMAX point of view:

NeedFrontMark contribution
Explain architectureDiagrams, visual blocks, structured sections, and callouts.
Show examplesHighlighted code, tabs, annotated snippets, and copyable blocks.
Present lightweight UI contentForms, cards, media blocks, and frontend-oriented containers.
Keep content portableMarkdown remains the authoring base instead of a custom page builder.
Separate concernsFrontMark handles documentation rendering, while sigMAX handles generation, contracts, and runtime behavior.

How It Fits

Section titled “How It Fits”

sigMAX focuses on contract-first generation, agreements, deterministic artifacts, and controlled execution. FrontMark sits next to that core system as the content surface for explanations and lightweight frontend material.

sigMAX core

Published surfaces

FrontMark layer

Authoring

authored as text

adds structure

renders

explains

illustrates

presents

Markdown source

FrontMark directives

Renderer

Callouts · tabs · diagrams · containers

Documentation pages

Examples and guides

Lightweight frontend content

Contracts

Agreements

Controlled runtime

FrontMark can describe a sigMAX concept, show a contract example, or publish a walkthrough. It should not be confused with the generated services, runtime sandbox, or Enterprise deployment infrastructure.

When to Use It

Section titled “When to Use It”

Use FrontMark when a sigMAX page needs more than plain paragraphs but does not need to become a standalone application.

Good uses include:

  • A concept page with callouts, diagrams, and examples.
  • A tutorial that mixes explanations, commands, screenshots, and warnings.
  • A frontend-facing documentation page with tabs, media, or structured blocks.
  • A compact visual explanation of a generated artifact or runtime boundary.

Avoid using FrontMark as the place to define core sigMAX behavior. Contracts, agreements, runtime rules, and generation boundaries should remain documented in the core sigMAX sections and source repositories.