GitHub/quartz
1
0
Fork 2
mirror of https://github.com/jackyzha0/quartz.git synced 2025-12-24 13:24:05 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(config): consistency, typo(s) and style

Browse Source
This commit is contained in:
geoffreygarrett 2022-07-03 13:48:45 +02:00
parent ad00fd6a5b
commit 9fa93bccc1
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
content/notes/config.md
View File

@ -35,8 +35,8 @@ enableCodeBlockCopy: true
enableLatex: true enableLatex: true
# whether to enable single-page-app style rendering # whether to enable single-page-app style rendering
# this prevents flahses of unstyled content and overall improves # this prevents flashes of unstyled content and improves
# smoothness of quartz. More info in issue #109 on GitHub # smoothness of Quartz. More info in issue #109 on GitHub
enableSPA: true enableSPA: true
# whether to render a footer # whether to render a footer
@ -86,10 +86,10 @@ To add code block titles with Quartz:
``` ```
**Note** that if `{title=<my-title>}` is included, and code block titles are not **Note** that if `{title=<my-title>}` is included, and code block titles are not
enabled, no errors will occur and the title attribute will be ignored. enabled, no errors will occur, and the title attribute will be ignored.
### HTML Favicons ### HTML Favicons
If you would like to customize the favicons of your quartz-based website, you If you would like to customize the favicons of your Quartz-based website, you
can add them to the `data/config.yaml` file. The **default** without any set can add them to the `data/config.yaml` file. The **default** without any set
`favicon` key is: `favicon` key is:
@ -98,7 +98,7 @@ can add them to the `data/config.yaml` file. The **default** without any set
``` ```
The default can be overridden by defining a value to the `favicon` key in your The default can be overridden by defining a value to the `favicon` key in your
`data/config.yaml` file. Here is a `List[Dictionary]` example format, which is `data/config.yaml` file. For example, here is a `List[Dictionary]` example format, which is
equivalent to the default: equivalent to the default:
```yaml {title="data/config.yaml", linenos=false} ```yaml {title="data/config.yaml", linenos=false}
@ -111,7 +111,7 @@ In this format, the keys are identical to their HTML representations.
If you plan to add multiple favicons generated by a website (see list below), it If you plan to add multiple favicons generated by a website (see list below), it
may be easier to define it as HTML. Here is an example which appends the may be easier to define it as HTML. Here is an example which appends the
**Apple touch icon** to quartz's default favicon: **Apple touch icon** to Quartz's default favicon:
```yaml {title="data/config.yaml", linenos=false} ```yaml {title="data/config.yaml", linenos=false}
favicon: | favicon: |
@ -121,7 +121,7 @@ favicon: |
This second favicon will now be used as a web page icon when someone adds your This second favicon will now be used as a web page icon when someone adds your
webpage to the home screen of their Apple device. If you are interested in more webpage to the home screen of their Apple device. If you are interested in more
information about the current, and past, standards of favicons, you can read information about the current and past standards of favicons, you can read
[this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/). [this article](https://www.emergeinteractive.com/insights/detail/the-essentials-of-favicons/).
**Note** that all generated favicon paths, defined by the `href` **Note** that all generated favicon paths, defined by the `href`
@ -184,7 +184,7 @@ paths:
Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing `assets/styles/custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`. Want to go even more in-depth? You can add custom CSS styling and change existing colours through editing `assets/styles/custom.scss`. If you'd like to target specific parts of the site, you can add ids and classes to the HTML partials in `/layouts/partials`.
### Partials ### Partials
Partials are what dictate what actually gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`. Partials are what dictate what gets rendered to the page. Want to change how pages are styled and structured? You can edit the appropriate layout in `/layouts`.
For example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html` For example, the structure of the home page can be edited through `/layouts/index.html`. To customize the footer, you can edit `/layouts/partials/footer.html`