Custom domains
Use your own domain for your documentation site.
Every project deployed with blode.md gets a subdomain at your-project.blode.md automatically. You can also point your own domain to your docs site for a fully branded experience.
When you run blodemd push, your docs are published to {name}.blode.md, where name is the value in your docs.json. No DNS configuration is required.
Decide whether to use a subdomain (e.g., docs.example.com) or an apex domain (e.g., example.com).
Subdomains are recommended. They are simpler to configure and do not interfere with your root domain's other records.
Add a CNAME record pointing your domain to cname.vercel-dns.com.
| Type | Name | Value |
|---|---|---|
| CNAME | docs | cname.vercel-dns.com |
For apex domains, some DNS providers require an A record instead of a CNAME. Check your provider's documentation for CNAME flattening or ALIAS record support.
If prompted, add the TXT verification record provided in your project dashboard:
| Type | Name | Value |
|---|---|---|
| TXT | _vercel.docs.example.com | vc-domain-verify=... |
Add the domain field to your docs.json:
{
"name": "my-project",
"domain": "docs.example.com"
}Then redeploy with blodemd push.
If you want your docs mounted at a subpath rather than the domain root, set pathPrefix in your docs.json:
{
"name": "my-project",
"domain": "docs.example.com",
"pathPrefix": "/docs"
}Your documentation will then be accessible at docs.example.com/docs instead of docs.example.com.
The path prefix is applied to all routes, including search, sitemaps, and API reference pages.