docs: pre-release documentation fixes
- Remove non-existent 'move' strategy from CLI docs - Update installation guide for v5 release (remove beta note, fix clone cmd) - Add fontOrigin configuration documentation - Document layout condition property with available presets - Add optional title font to typography example
This commit is contained in:
@@ -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.
|
- **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.
|
- **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.
|
- **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
|
## Link Resolution
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
- 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](<https://en.wikipedia.org/wiki/Glob_(programming)>) patterns that Quartz should ignore and not search through when looking for files inside the `content` folder. See [[private pages]] for more details.
|
- `ignorePatterns`: a list of [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) 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.
|
- `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.
|
- `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.
|
- `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)
|
- `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:
|
configuration:
|
||||||
theme:
|
theme:
|
||||||
typography:
|
typography:
|
||||||
|
title: Schibsted Grotesk # optional, defaults to header font
|
||||||
header: Schibsted Grotesk
|
header: Schibsted Grotesk
|
||||||
body: Source Sans Pro
|
body: Source Sans Pro
|
||||||
code: IBM Plex Mono
|
code: IBM Plex Mono
|
||||||
|
|||||||
@@ -9,13 +9,10 @@ This page walks you through the full Quartz setup: from cloning the repository t
|
|||||||
## 1. Clone Quartz
|
## 1. Clone Quartz
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone -b v5 https://github.com/jackyzha0/quartz.git
|
git clone https://github.com/jackyzha0/quartz.git
|
||||||
cd quartz
|
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
|
## 2. Install Dependencies
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -108,6 +108,29 @@ layout:
|
|||||||
right: []
|
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`:
|
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"
|
```ts title="quartz.ts"
|
||||||
|
|||||||
Reference in New Issue
Block a user