diff --git a/docs/cli/create.md b/docs/cli/create.md index 591d923..227d852 100644 --- a/docs/cli/create.md +++ b/docs/cli/create.md @@ -40,7 +40,6 @@ When you run `quartz create`, you must choose a strategy for your content: - **new**: Creates a fresh, empty content folder. Use this if you are starting a new project from scratch. - **copy**: Copies all files from your source directory into the Quartz content folder. This is the safest option for existing vaults as it doesn't touch your original files. - **symlink**: Creates a symbolic link from the Quartz content folder to your source directory. Any changes you make in your source directory (e.g. in Obsidian) will be immediately reflected in Quartz. -- **move**: Moves your files from the source directory into the Quartz content folder. ## Link Resolution diff --git a/docs/configuration.md b/docs/configuration.md index 6d89d50..9357745 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -47,6 +47,9 @@ This part of the configuration concerns anything that can affect the whole site. - Note that Quartz 5 will avoid using this as much as possible and use relative URLs whenever it can to make sure your site works no matter _where_ you end up actually deploying it. - `ignorePatterns`: a list of [glob]() patterns that Quartz should ignore and not search through when looking for files inside the `content` folder. See [[private pages]] for more details. - `theme`: configure how the site looks. + - `fontOrigin`: where to load fonts from. + - `"googleFonts"` (default): loads fonts from Google Fonts API. Fastest option, especially with CDN caching enabled. + - `"local"`: downloads fonts and serves them from your site. Fully self-contained with no external requests. - `cdnCaching`: if `true` (default), use Google CDN to cache the fonts. This will generally be faster. Disable (`false`) this if you want Quartz to download the fonts to be self-contained. - `typography`: what fonts to use. Any font available on [Google Fonts](https://fonts.google.com/) works here. - `title`: font for the title of the site (optional, same as `header` by default) @@ -263,6 +266,7 @@ Fonts can be specified as a simple string or with advanced options in `quartz.co configuration: theme: typography: + title: Schibsted Grotesk # optional, defaults to header font header: Schibsted Grotesk body: Source Sans Pro code: IBM Plex Mono diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 96cc137..8949aa4 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -9,13 +9,10 @@ This page walks you through the full Quartz setup: from cloning the repository t ## 1. Clone Quartz ```bash -git clone -b v5 https://github.com/jackyzha0/quartz.git +git clone https://github.com/jackyzha0/quartz.git cd quartz ``` -> [!note] -> Quartz 5 is currently in beta, so the default branch is still v4. The `-b v5` flag ensures you clone the right branch. - ## 2. Install Dependencies ```bash diff --git a/docs/layout.md b/docs/layout.md index 0af229d..b44bcf7 100644 --- a/docs/layout.md +++ b/docs/layout.md @@ -108,6 +108,29 @@ layout: right: [] ``` +### Conditional Rendering + +Plugins can specify a `condition` in their layout block to control when they appear. This uses built-in presets: + +```yaml title="quartz.config.yaml" +plugins: + - source: github:quartz-community/breadcrumbs + enabled: true + layout: + position: beforeBody + priority: 5 + condition: not-index +``` + +Available conditions: + +| Condition | Effect | +| ----------- | ---------------------------------------------------- | +| `not-index` | Hidden on the root index page, shown everywhere else | +| `has-tags` | Only shown on pages that have tags in frontmatter | + +See [[layout-components]] for more details on conditional rendering and display options. + For advanced layout overrides using TypeScript (e.g. custom component wrappers or conditional logic), you can use the TS override in `quartz.ts`: ```ts title="quartz.ts"