xyd 0.1.0-alpha - Coming Soon

Writing Content
/
Compose Content

Compose ContentExperimental

Learn how to streamline content experience

xyd combines generated and manual content into composition to create powerful documentation. Use composition along with uniform, components or functions to build rich, interactive documentation.

Supported uniform extensions

Uniform translates code automatically based on supported extensions:

  • .tsx for React components
  • .ts for TypeScript code (soon)
  • .py for Python code (soon)
  • .go for Go code (soon)

Uniform Pages

The uniform field in page meta generates API documentation automatically:

---
title: Callouts
icon: info
layout: wide
uniform: "@components/writer/Callout/Callout.tsx"
---

Compose Uniform Pages

You can also customize uniform pages:

---
<!-- ... -->
---
<!-- BELOW CONTENT IS COMPOSED - EXTENDS API PAGE BY CUSTOM CONTENT -->
### Examples
:::callout
Note that you must have an Admin or Owner role to manage webhook settings.
:::

Output VariablesComing Soon

<!-- -->
<!-- YOU CAN USE OUTPUT VARIABLES TOO -->
@let(
.examples = (
```tsx
<Callout>
Note that you must have an Admin or Owner role to manage webhook settings.
</Callout>
```
```md
:::callout
Note that you must have an Admin or Owner role to manage webhook settings.
:::
```
))
React ComponentsCustomization Quickstart
Built with

Show your support! Star us on GitHub ⭐️