This plugin writes a CNAME file to the root of the output folder containing the hostname of configuration.baseUrl (for baseUrl: quartz.example.com/docs that is quartz.example.com). Hosts such as GitHub Pages read this file to serve the site on a custom domain. If baseUrl is not set, the plugin warns and writes nothing.
If you want to use a custom domain name like quartz.example.com for the site, then this is needed.
See Hosting for more information.
Note
For information on how to add, remove or configure plugins, see the Configuration page.
This plugin has no configuration options.
API
- Category: Emitter
- Function name:
ExternalPlugin.CNAME(). - Source:
quartz-community/cname - Install:
npx quartz plugin add @quartz-community/cname