Skip to Content
Rendered by Nextra 4.6.0 with cudoc: Markdown source · Embedded source · Setup guide · Example code · All demos
cudoc showcase

cudoc showcase

Every cudoc feature appears at least once below. The same file is rendered by each example site, so the anchor ids, badge text, list structure and table layout have to come out the same in all of them.

Heading anchors

A heading carries its own anchor id, so a deep link keeps working after the heading is reworded.

Nested heading

Anchors are collected at every configured depth, not only at the top level.

Rate limitsREST API

A heading may carry a badge as well as an id. The badge moves onto the anchor element instead of staying in the heading text.

Retry policybeta

Retries are capped, and the cap is part of the response.

Inline badges

This field is deprecated and will be removed in the next major version. A sentence may carry two separate badges without losing the text between them.

Badge syntax inside a link (@not a badge)  stays literal, because a badge there would nest interactive content.

Lists inside table cells

Markdown cannot put a list in a table cell, so the markers are read from the cell’s raw source and rebuilt as real list nodes.

PurposeDetail
Identity
  • Proves membership
    • Student card
    • Staff card
  • Proves a qualification
Access
  1. Request a token
  2. Call the endpoint
    1. Send the header
    2. Read the result
PlainNo markers here, so the cell is left exactly as written.
Requirements

A column holding many items reads badly in one narrow cell, so a layout rule splits it and spans the header to keep the grid rectangular.

MethodPrerequisites
GET
  • An account
  • A project
  • An issued key
  • The scope granted
POST
  • An account
  • A project
Last updated on