Deploy your`xyd`docs

Learn how to make your docs available to the public

You must follow the following steps to deploy your xyd docs:

bunx / npx / xyd CLI installed on CI.

You run build command inside your docs project.

Build

Run this command to build the docs:

$ bunx xyd-js build

Info

This produces a static files availalbe at .xyd/build/client folder within your docs project. You can serve that locally using popular static web servers or just deploy it on production.

Deployment

Since xyd build produces static files you can deploy it on any infrastructure you want very easy. Just point to generated folder which you could upload to your provider.

netlify.toml

[build]
command = "bunx xyd-js build"
publish = ".xyd/build/client"

Tip

Check out Netlify Deployment Sample.

Check out more Deploy Samples.

Quicktart Compare

Deploy yourxyddocs

Learn how to make your docs available to the public

Build

Deployment

Deploy your`xyd`docs