Skip to content

FrontMark in sigMAX

FrontMark is the enriched Markdown layer used around the sigMAX ecosystem 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.

This page imports only the boundary context from the sigMAX documentation. The full syntax reference, examples and implementation notes remain in this FrontMark space.

View the sigMAX devsite repository Explore FrontMark features

The sigMAX flavor of FrontMark uses the usual dark technical palette: deep ink backgrounds, blue-green panels, bright cyan accents and restrained status colors. These colors are exposed as theme tokens so documentation pages, generated blocks and Markdown enhancements can share the same visual identity.

RoleColorUsage
Ink #000713Main page depth and dark surfaces.
Night #001522Navigation, recessed panels and background gradients.
Deep #062b42Documentation sidebars and secondary surfaces.
Panel #073047Cards, tables, controls and framed content.
Soft panel #0d6f84Hover states and quiet emphasis.
Accent #12c6d8Primary links, active states and action focus.
Bright accent #75d5f0Highlights, glows and readable cyan details.
Soft accent #b7f7fbLight cyan surfaces and subtle backgrounds.
Text #f3fbffMain text over dark backgrounds.
Muted text #b9d2dcSecondary copy and low-emphasis labels.
Warning #ffcc28Warnings and attention states.
Danger #a94c5bDestructive or critical states.

FrontMark gives sigMAX a concise way to expose human-readable content without turning that content into a generated application frontend. It is useful for documentation pages, tutorials, examples, architecture explanations and compact interactive documentation blocks.

Its role is deliberately narrow:

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

FrontMark starts from Markdown and adds a rendering layer for richer documentation patterns.

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.

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 diagrams use a stable visual convention: light readable node fills, dark text, strong borders, thick pale arrows and clear bold labels. Source material is usually cyan, FrontMark or enrichment layers are green, documentation surfaces are blue, and sigMAX core/runtime concerns are amber or dark neutral depending on the diagram.

explain

illustrate

Markdown source

FrontMark directives

FrontMark renderer

Documentation pages

Examples and guides

sigMAX contracts, agreements and runtime

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

Use FrontMark when a sigMAX-related 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 source of truth for core sigMAX behavior. Contracts, agreements, runtime rules and generation boundaries should remain documented in the sigMAX sections and source repositories.