Quartz's default cname plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:01:34 +01:00
.changeset chore: version package 2026-11-08 13:47:33 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:26 +01:00
src style: format files 2026-07-23 09:22:54 +02:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:06:50 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 23:35:27 +01:00
CHANGELOG.md chore: version package 2026-11-08 13:47:33 +00:00
LICENSE Initial commit 2026-02-13 23:35:27 +01:00
package-lock.json chore: version package 2026-11-08 13:47:33 +00:00
package.json chore: version package 2026-11-08 13:47:33 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:56:17 +01:00
tsconfig.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:29 +02:00
vitest.config.ts fix: add vitest devDependency and passWithNoTests config 2026-03-09 03:21:37 +01:00

@quartz-community/cname

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), for custom domain hosting on GitHub Pages and similar hosts. If baseUrl is not set, the plugin warns and writes nothing.

Installation

npx quartz plugin add @quartz-community/cname

It is already included (and enabled) in the default quartz.config.yaml.

Usage

plugins:
  - source: "@quartz-community/cname"
    enabled: true

Configuration

This plugin has no configuration options.

Documentation

See the Quartz documentation for more information.

License

MIT