Bring Fern Docs to your custom domain.
You can use:
docs.example.comexample.com/docsexample.comTo host your documentation on a subdomain, i.e. docs.mydomain.com, you need to create a CNAME record in your DNS settings.
CNAMEdocs (or any subdomain you want to use)cname.vercel-dns.com.Once you’ve completed the steps above, reach out via your dedicated Slack channel or email.
You may need to create a TXT record to verify your domain. If you do, we’ll provide you with the record to add.
Once we’ve completed the setup on our end, you should be able to access your documentation at docs.mydomain.com. SSL will be automatically provisioned for your domain, but it may take a few minutes to propagate globally.
To host your documentation on a subpath, i.e. mydomain.com/docs, you need to edit your docs.yml configuration and then get provider-specific instructions for setting up the subpath. Common providers include Cloudflare, AWS Route53 and Cloudfront, Netlify, and Vercel.
url in docs.ymlAppend that subpath to the end of the url. This example use docs for the subpath, but you can use any word you like, such as reference or developer.
custom-domainBelow the url, add a custom-domain key as shown in the examples below.
If you created your Fern Docs site using one of our Docs Quickstarts, push the changes you made to your GitHub repository. This runs a GitHub Action to update the site with your new configuration.
If you need to update your Fern Docs site manually, run fern generate --docs.
This feature is available on the Fern Docs Basic plan and above. Reach out to sales@buildwithfern.com to set up your subscription and obtain the configuration for setting up your custom subpath.
To host your documentation on a root domain, i.e. mydomain.com, you need to edit your docs.yml configuration and then get provider-specific instructions for setting up the domain. Common providers include Cloudflare, AWS Route53 and Cloudfront, Netlify, and Vercel.