Getting Started with Super Markdown
Integrate our component system to elevate your Markdown documents with superior functionality, ensuring a contemporary, professional standard of quality and impact.
What is Super Markdown ?
Super Markdown is not just another Markdown parser, it's a complete evolution of the Markdown experience.
Born from the need to combine the simplicity of plain text with the demands of modern content creation, Super Markdown allows you to write naturally while unlocking capabilities that traditional Markdown simply cannot offer.
Whether you're building technical documentation, crafting professional articles, designing presentations, or managing a knowledge base, Super Markdown gives you the freedom to write simply and publish beautifully.
What makes it different ?
| Standard Markdown | Super Markdown |
|---|---|
| Basic text formatting | Rich, Dynamic components |
| Static content | Interactive and structured elements |
| Limited layout control | Modern, professional layouts |
| One format, one output | Flexible rendering across multiple channels |
| Ability to be customized is limited. | Customization is unlimited |
With Super Markdown, your documents become more than text, they become powerful, structured, and visually compelling assets.
The Component System: Your Superpowers
The heart of Super Markdown is the Component System, a revolutionary way to enhance your documents without sacrificing the simplicity of Markdown.
What are components ?
Components are reusable, dynamic building blocks that you can embed directly into your Markdown documents. Think of them as "superpowers" that extend what your content can do.
Instead of writing complex code or switching to a heavy document editor, you simply invoke components using an intuitive syntax. Each component is designed to solve a specific need, from displaying data elegantly to creating interactive layouts.
How components work
Components follow a simple pattern that feels natural within your Markdown workflow:
:: component{attr=”value” attr2=”value2”} :: componentThis structure keeps your source clean and readable while giving you access to powerful functionality.
Examples of components in action
Header Component
Card Component
Why components matter
Consistency
Maintain a unified visual identity across all your documents
Efficiency
Reuse complex structures without rewriting them
Flexibility
Update components globally, change once, apply everywhere
Professionalism
Deliver polished, modern content that stands out
From Simple Markdown to Professional Content
Write naturally
Start with familiar Markdown syntax. Headings, lists, links, and formatting work exactly as you expect.
Enhance with components
Add components where you need advanced structure or interactivity. Your document remains readable in its source.
Render professionally
Super Markdown transforms your enriched content into modern, professional output
Manage with confidence
Organize your documents in folders, track versions, and publish across multiple channels with complete control.
Write your first document
Card Component
See your document rendered in real-time. When you're ready, publish directly from your workspace or export to your preferred format.
-
Additional tools
We are actively building new capabilities to simplify the deployment of Markdown documents outside the cloud platform, offering our users enhanced flexibility and full ownership of their documents in their local machines.
Important note regarding component parameters
-
Important note
When developing your documents with Super Markdown, be aware that certain global settings are used across almost all components. Their purpose is to give you more control and flexibility when modifying and editing your documents.
Here is a list of the most common settings, which you can find in most components:
- theme : This parameter defines all the colors to be applied to the component globally, including animations, if applicable.
- font : This parameter controls the fonts used within the component. This can be applied to only the headings or to the entire content of the component, depending on the desired final look.
- align : This parameter adjusts the alignment of inline elements within the component.
- box_type : This parameter modifies the horizontal space the component occupies relative to the available space. Note that the component to which this setting is applied will be horizontally centered within the remaining space.
- mode : This parameter controls the different designs or versions offered by the component. It can generate multiple variations of the same component depending on the needs.
- id : This parameter creates internal navigation within the document to link different content sections together. For example, an "Appendices" button redirects the user to the "Appendices" section, thus strengthening the connection between the different sections of the document.
What's Next ?
- LLM Integration : Getting Started with LLM Integration
- Fréquents Questions : A collection of frequently asked questions related to the platform
- Super Markdown API : TGetting Started with Super Markdown API
Need help ? Our team is here to support you. Contact us or check our FAQ.