Quickstart

Get Started

Quickstart

Start building modern documentation in record time

Follow the instructions below to learn how to run, deploy, update and supercharge your documentation with xyd.

Prerequisite: Node 22.12+

Installation

Install the xyd CLI:

xyd installation

bun add -g xyd-js

Note: There are known issues with Bun v1.2.21. If you encounter problems, consider using a different Bun version or switch to another supported package manager.

Clone starter by following command:

git clone https://github.com/xyd-js/starter
cd starter

Execute CLI with the following command:

xyd

Info

Above command runs a dev server

CLI versioning

Please note that each CLI release is associated with a specific version of xyd. If you have troubles, please update the CLI:

xyd update

bun add -g xyd-js

Troubleshooting

If you have troubles with CLI the common task is deleting xyd cache:

rm -rf .xyd

Publishing

Publishing changes depends on your preferences, the simplest way is to use the one of infrastructure providers like Netlify or Vercel. Learn more about deploy.

Starter

Use our starter kit to get up and running quickly.

Examples

Please checkout examples to learn how to setup docs as you want.

CodeSandbox Demo

Please checkout CodeSanbox demo.

Edit page

Introduction Deploy