PlanCover Docs

Components

The MDX components available when writing a page in this documentation site.

Everything below is available in any .mdx file under content/docs without an import.

Callouts

Note

Use a callout for something the reader must not miss. Sparingly — a page with four callouts has none.

Warning

For a decision that is not settled, or a step that can lose data.

Error

For something that will break if ignored.

Code

Code blocks carry a title, copy to clipboard, and line highlighting.

app/api/chat.py
@router.post("/stream")
async def stream_chat(
    request: ChatRequest,
    auth: AuthContext = Depends(require_member),
) -> StreamingResponse:
    """The HTTP boundary only: validate, authorise, stream, map errors."""
    return StreamingResponse(
        run_chat_graph(request, auth),
        media_type="text/event-stream",
    )
make lint typecheck test

Cards

Steps

First

Steps number themselves and draw a rail down the left.

Second

Useful for anything with a required order.

Tabs

bun install
bun run dev

Tables

ColumnTypeNotes
conversation_idstringStable for the life of a conversation
channelenumweb, mobile or whatsapp
historyarrayRecent turns; the backend is stateless

Typography

Regular paragraphs, bold, italic, inline code, and links all render with the site's type scale.

Blockquotes are available for pulling out a line worth dwelling on.

On this page