| | |
|---|
| | | title: Authoring Content |
|---|
| | | --- |
|---|
| | | |
|---|
| | | All of the content in your Quartz should go in the `/content` folder. The content for the home page of your Quartz lives in `content/index.md`. If you've [[index#🪴 Get Started|setup Quartz]] already, this folder should already be initailized. Any Markdown in this folder will get processed by Quartz. |
|---|
| | | All of the content in your Quartz should go in the `/content` folder. The content for the home page of your Quartz lives in `content/index.md`. If you've [[index#🪴 Get Started|setup Quartz]] already, this folder should already be initialized. Any Markdown in this folder will get processed by Quartz. |
|---|
| | | |
|---|
| | | It is recommended that you use [Obsidian](https://obsidian.md/) as a way to edit and maintain your Quartz. It comes with a nice editor and graphical interface to preview, edit, and link your local files and attachments. |
|---|
| | | |
|---|
| | |
|---|
| | | Some common frontmatter fields that are natively supported by Quartz: |
|---|
| | | |
|---|
| | | - `title`: Title of the page. If it isn't provided, Quartz will use the name of the file as the title. |
|---|
| | | - `description`: Description of the page used for link previews. |
|---|
| | | - `permalink`: A custom URL for the page that will remain constant even if the path to the file changes. |
|---|
| | | - `aliases`: Other names for this note. This is a list of strings. |
|---|
| | | - `tags`: Tags for this note. |
|---|
| | | - `draft`: Whether to publish the page or not. This is one way to make [[private pages|pages private]] in Quartz. |
|---|
| | | - `date`: A string representing the day the note was published. Normally uses `YYYY-MM-DD` format. |
|---|
| | | |
|---|
| | | See [[Frontmatter]] for a complete list of frontmatter. |
|---|
| | | |
|---|
| | | ## Syncing your Content |
|---|
| | | |
|---|
| | | When you're Quartz is at a point you're happy with, you can save your changes to GitHub by doing `npx quartz sync`. |
|---|
| | | When your Quartz is at a point you're happy with, you can save your changes to GitHub. |
|---|
| | | First, make sure you've [[setting up your GitHub repository|already setup your GitHub repository]] and then do `npx quartz sync`. |
|---|
| | | |
|---|
| | | > [!hint] Flags and options |
|---|
| | | > For full help options, you can run `npx quartz sync --help`. |
|---|
| | | > |
|---|
| | | > Most of these have sensible defaults but you can override them if you have a custom setup: |
|---|
| | | > |
|---|
| | | > - `-d` or `--directory`: the content folder. This is normally just `content` |
|---|
| | | > - `-v` or `--verbose`: print out extra logging information |
|---|
| | | > - `--commit` or `--no-commit`: whether to make a `git` commit for your changes |
|---|
| | | > - `--push` or `--no-push`: whether to push updates to your GitHub fork of Quartz |
|---|
| | | > - `--pull` or `--no-pull`: whether to try and pull in any updates from your GitHub fork (i.e. from other devices) before pushing |
|---|
| | | ## Customization |
|---|
| | | |
|---|
| | | Frontmatter parsing for `title`, `tags`, `aliases` and `cssclasses` is a functionality of the [[Frontmatter]] plugin, `date` is handled by the [[CreatedModifiedDate]] plugin and `description` by the [[Description]] plugin. See the plugin pages for customization options. |
|---|
