FrontMark
FrontMark
Section titled “FrontMark”
Enriched Markdown Engine · Parse · Extend · Render. FrontMark parses Markdown, extends it with rich content and components, and renders pages within the sigMAX constellation.
FrontMark turns Markdown into documentation, examples and lightweight application frontends. This site uses its publishing layer; Studio exposes its frontend workspace through the front-ui project extension. See Astro / Svelte / Vite for the implementation.
A small publishing layer, not another runtime
Readable source → structured pages. Visual callouts and links connect explanations to the project pieces that own the behavior.
Role in sigMAX
Section titled “Role in sigMAX”FrontMark publishes documentation pages, examples, tutorials and visual explanations. Through Studio, it also supplies an application’s frontend, combining Markdown pages with reusable Svelte components behind a declared ingress.
Author & explain
- Publish enriched Markdown for sigMAX-related pages.
- Keep detailed syntax, examples and implementation notes in the dedicated FrontMark space.
- Preserve a simple technical writing workflow.
Build & publish
- Evolve frontend and documentation separately from the generator and runtime.
- Build and publish the project frontend independently of WASM handlers.
Frontend Authoring in Studio
Section titled “Frontend Authoring in Studio”The front-ui extent depends on Traefik. Studio provides site setup, branding images, language and URL settings, Markdown page management, menu metadata and reusable Svelte component editing. The selected site URL comes from a configured frontend ingress.
The workspace can synchronize its configured source, compile components, build and test the site, and start or stop the frontend runtime. Authentik integration can provide OIDC/PKCE configuration for the browser interface. Backend APIs retain their own contracts and runtime capabilities.
Studio workspace · Routing and identity
What FrontMark Adds
Section titled “What FrontMark Adds”FrontMark starts from Markdown and adds a rendering layer for richer documentation patterns. The supported syntax is defined by the FrontMark renderer. From the sigMAX point of view:
| Need | FrontMark contribution |
|---|---|
| Explain architecture | Diagrams, visual blocks, structured sections, and callouts. |
| Show examples | Highlighted code, tabs, annotated snippets, and copyable blocks. |
| Present lightweight UI content | Forms, cards, media blocks, and frontend-oriented containers. |
| Keep content portable | Markdown remains the authoring base instead of a custom page builder. |
| Separate concerns | FrontMark 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.
Blue shapes represent authored content and its subjects, turquoise steps represent rendering, and the green terminal represents published pages. The dotted link describes what the pages present; it is not a backend execution call.
FrontMark can describe a sigMAX concept, show a contract example, publish a walkthrough or provide application pages through Studio’s frontend workspace. Generated services and the WASM executor own the backend behavior.
FrontMark does not define an edition. sigMAX has two proprietary editions: Core on Docker Compose and Pro on Kubernetes with COS2000 in a KubeVirt VM. Public documentation does not imply public access to the product source.
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.