io.display.markdown
Formatted text, written in markdown.
io.display.markdown shows formatted text in a page or in a step of an action. You write it in markdown: headings, paragraphs, lists, links and code. Use it for a warning before a delete or a short note on a page. It only displays and returns nothing.
The simplest one
The whole action file, and roughly what your team sees when it runs.
Delete account
- Their runs stay in the log
- Invoices are kept for 10 years
What you can set
The settings you will reach for most, each with the line of code that turns it on.
Headings, lists, links and code. Enough for the steps of a task, a checklist or a link to your policy.
Just the text. The markdown is the first and only argument. There are no props to learn.
Values from your data. Write it as a template string and put values from the database right into the text.
No markup from your data. Raw HTML in the text is shown as text. A value from the database cannot add its own markup.
Before a question. In io.group it sits next to inputs, such as a warning right above the box that confirms a delete.
On a page. Return it from a page handler to put a note or a rule on a folder's page.
More in the docs
This page shows the idea. The docs have every prop, the checks on the server and more examples.
Next components
Three more calls on io. Each one shows a control and hands your code a typed value.
Write your first tool today.
An async function, a few await calls, and the form is in the browser.