Content
Text people read: rendered Markdown, a write-and-preview field, code with a copy button, single commands, program output and a still terminal screen. Code and output scroll inside their own box, so the page never scrolls sideways.
7 pages, 7 exports
- Markdown
- Prose
- MarkdownField
- CodeBlock
- Snippet
- OutputBox
- TerminalScreen
ImportLink to the section Import
Each group has its own entry, so an app that needs only this group loads only this group. Everything is also exported from @skribly/ui.
import { Markdown, Prose, MarkdownField, CodeBlock, … } from '@skribly/ui/content'Pages in this groupLink to the section Pages in this group
- MarkdownRenders Markdown from a user, a tracker or an agent as safe HTML. It runs on the server too, with no DOM, so pick it for any stored Markdown text.Markdown
- ProseGives plain HTML the reading styles of Skribly. Pick it for long text written in JSX or HTML from your own source; use Markdown for Markdown.Prose
- MarkdownFieldA text area for Markdown with a preview tab, for descriptions and comments. Pick it when the text will be shown rendered; use a plain TextField for short values.MarkdownField
- CodeBlockShows a block of code with an optional file name, language tag, line numbers and copy button. Pick Snippet for a single command.CodeBlock
- SnippetOne command or key with a copy button, such as an install line. The text wraps, so it fits a phone screen.Snippet
- OutputBoxProgram output such as an install or build log, with an optional outcome. Pick it for text a tool printed; pick CodeBlock for source code.OutputBox
- TerminalScreenA still picture of a terminal, such as the last lines of an agent session on an overview card. Pick it to preview; a live terminal needs xterm in the app.TerminalScreen