FAQ
Is FrontMark a final product?
Section titled “Is FrontMark a final product?”No. This version is a test presentation site. It provides a clean base for validating the brand, navigation, documentation structure and enhanced Markdown rendering before a more complete release.
How does FrontMark relate to sigMAX?
Section titled “How does FrontMark relate to sigMAX?”FrontMark is part of the wider sigMAX ecosystem as a publishing and rendering layer for enriched Markdown. It is not the sigMAX generator, runtime, contract model or deployment infrastructure. The short boundary is documented in FrontMark in sigMAX.
What is the source of truth for the documentation?
Section titled “What is the source of truth for the documentation?”The source content lives in src/content/docs. Each Markdown file maps to a documentation route, for example images-material.md becomes /docs/images-material/.
Why was the original FrontMark document split?
Section titled “Why was the original FrontMark document split?”The original document was divided into focused pages so each feature has a stable URL, a clearer sidebar entry and a smaller page to maintain. This also makes search, tags and future CMS editing easier to reason about.
Which pages are available?
Section titled “Which pages are available?”The documentation is split into feature pages for images, parallax, containers, admonitions, annotations, buttons, code blocks, tabs, tables, charts, diagrams, footnotes, formatting, forms, multilingual behavior, grids, icons, lists, math, tooltips, hexadecimal output, n8n workflows, videos and Asciinema.
Does the site still contain the previous project?
Section titled “Does the site still contain the previous project?”The visible source content has been replaced with FrontMark content. Old project routes and references were removed from the documentation source, and generated artifacts are recreated on the next build.
Can more pages be added?
Section titled “Can more pages be added?”Yes. Add a Markdown file in src/content/docs, then add it to the Starlight sidebar in astro.config.mjs when it should appear in navigation.
Can I import my MkDocs Material project?
Section titled “Can I import my MkDocs Material project?”Yes. Use make import /path/to/mkdocs-site or make import MKDOCS=/path/to/mkdocs-site to import an existing MkDocs Material project into FrontMark. To install dependencies and import in one run, use make install import /path/to/mkdocs-site. The importer reads mkdocs.yml or mkdocs.yaml, copies Markdown and public assets into FrontMark locations, rewrites common media links and converts nav into the FrontMark sidebar configuration. Run make erase-all before importing when you want to empty the existing top menu and sidebar; it keeps their previous values as temporary comments, then make import removes those comments after importing navigation.
It intentionally imports portable content and navigation, not every MkDocs Material theme option. Custom palettes, features, arbitrary extra values, extra_css, extra_javascript and project-specific overrides should be reviewed manually after import.
See Going further for the full import behavior and test command.
Can the sidebar icons be changed?
Section titled “Can the sidebar icons be changed?”Yes. Sidebar entries are defined with Iconify-style names such as material-image-outline, fontawesome-solid-hashtag or simple-n8n. If an exact match does not exist, use the closest visual equivalent.
How does the language switcher work?
Section titled “How does the language switcher work?”The source site is authored in English. The bottom toolbar exposes English, French and Spanish, then the runtime translation layer handles non-English display for visitors.
Is translated content stored as separate Markdown files?
Section titled “Is translated content stored as separate Markdown files?”No. The Markdown source stays in English. Translation is handled in the browser, which keeps authoring simple while still allowing visitors to switch languages.
Can FrontMark content be edited through the CMS?
Section titled “Can FrontMark content be edited through the CMS?”The project includes a CMS entry point. Markdown pages remain plain files, so they can be edited directly or exposed through the CMS configuration as the editorial workflow evolves.
What kinds of Markdown extensions are supported?
Section titled “What kinds of Markdown extensions are supported?”The site demonstrates MkDocs Material-style syntax and FrontMark additions: admonitions, annotations, content tabs, data tables, cards, icons, math, charts, media embeds, forms, parallax sections, hexadecimal blocks and workflow snippets.
Are charts and diagrams rendered at build time?
Section titled “Are charts and diagrams rendered at build time?”The Markdown is processed during the Astro build, while some interactive visuals rely on browser-side scripts. This keeps pages static-friendly while preserving richer runtime behavior.
Can local media be used?
Section titled “Can local media be used?”Yes. Images, videos, Asciinema recordings and other public assets can live under public/ and be referenced from Markdown with absolute paths such as /images/... or /videos/....
What should be checked before publishing?
Section titled “What should be checked before publishing?”Run the build, inspect representative pages, verify that the sidebar links resolve, confirm that generated search/tag indexes are fresh, and check that the transparent logo renders correctly on light and dark backgrounds.
Where should new FrontMark examples go?
Section titled “Where should new FrontMark examples go?”Place feature examples in the matching documentation page. If an example introduces a new concept, add a short glossary entry and consider adding an FAQ item for expected author questions.