ficd/zona
1
Fork 0
Code Issues 1 Pull requests Projects Releases 5 Packages Wiki Activity Actions

updated documentation

Browse source
This commit is contained in:
Daniel Fichtinger 2025-07-15 18:42:32 -04:00
parent 4ea80a33f8
commit d35d3f61fb
1 changed files with 15 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -101,10 +101,6 @@ If you don't want discovery, you can specify the project root as the first
argument to `zona build`. You may specify a path for the output using the argument to `zona build`. You may specify a path for the output using the
`--output/-o` flag. The `--draft/-d` flag includes draft posts in the output. `--output/-o` flag. The `--draft/-d` flag includes draft posts in the output.
_Note: the previous build is _not_ cleaned before the new site is built. If
you've deleted some pages, you may need to remove the output directory before
rebuilding._
### Live Preview ### Live Preview
To make the writing process as frictionless as possible, zona ships with a live To make the writing process as frictionless as possible, zona ships with a live
@ -121,9 +117,10 @@ By default, the build outputs to a temporary directory. Use `-o/--output` to
override this. override this.
**Note**: if the live preview isn't working as expected, try restarting the **Note**: if the live preview isn't working as expected, try restarting the
server. If you change the configuration or any templates, the server must also server. If you change the configuration, the server must also be restarted. The
be restarted. The live preview uses the same function as `zona build` live preview uses the same function as `zona build` internally; this means that
internally; this means that the output is also written to disk. the output is also written to disk --- a temporary directory by default, unless
overridden with `-o/--output`.
#### Live Reload #### Live Reload
@ -196,13 +193,17 @@ the packaged defaults. To apply a certain template to a page, set the `template`
option in its [frontmatter](#frontmatter). The following public variables are option in its [frontmatter](#frontmatter). The following public variables are
made available to the template engine: made available to the template engine:
| Name | Description | | Name | Description |
| ---------- | ------------------------------------------------------ | | ----------- | -------------------------------------------------------- |
| `content` | The content of this page. | | `content` | The content of this page. |
| `url` | The resolved URL of this page. | | `url` | The resolved URL of this page. |
| `metadata` | The frontmatter of this page (_merged with defaults_). | | `metadata` | The frontmatter of this page (_merged with defaults_). |
| `header` | The sitemap header in HTML form. Can be `False`. | | `header` | The sitemap header in HTML form. Can be `False`. |
| `footer` | The footer in HTML form. Can be `False`. | | `footer` | The footer in HTML form. Can be `False`. |
| `is_post` | Whether this page is a post. |
| `newer` | URL of the newer post in the post list. |
| `older` | URL of the older post in the post list. |
| `post_list` | A sorted list of `Item` objects. Meant for internal use. |
#### Markdown Footer #### Markdown Footer