diff --git a/docs/books/_book-vs-website-key.qmd b/docs/books/_book-vs-website-key.qmd index 4d8aadadb9..c8409ebab2 100644 --- a/docs/books/_book-vs-website-key.qmd +++ b/docs/books/_book-vs-website-key.qmd @@ -1,10 +1,12 @@ -One important thing to note about using website tools is that while these tools are added to websites within the `website` key, in a book you should include the same options in the `book` key. For example, in a website you would include a favicon and twitter card as follows: +One important thing to note about using website tools is that while these tools are added to websites within the `website` key, in a book you should include the same options in the `book` key. For example, in a website you would include a favicon, twitter card, and analytics as follows: ```yaml website: favicon: logo.png twitter-card: true site-url: https://example.com + plausible-analytics: + path: _plausible_snippet.html ``` In a book you'd use the `book` key instead: @@ -14,5 +16,7 @@ book: favicon: logo.png twitter-card: true site-url: https://example.com + plausible-analytics: + path: _plausible_snippet.html ``` diff --git a/docs/websites/website-tools.qmd b/docs/websites/website-tools.qmd index 87e97cd709..94f3d79cbb 100644 --- a/docs/websites/website-tools.qmd +++ b/docs/websites/website-tools.qmd @@ -2,6 +2,10 @@ title: "Website Tools" --- +{{< include ../books/_book-vs-website-key.qmd >}} + +As you read the documentation below, keep in mind to substitute `book` for `website` if you are authoring a book. + ## Headers & Footers You can provide standard headers and footers for pages on your site. These can apply to the main document body or to the sidebar. Available options include: @@ -64,10 +68,6 @@ You can enhance your website and the content that you publish to it by including - Twitter Cards - Open Graph -{{< include ../books/_book-vs-website-key.qmd >}} - -As you read the documentation below, keep in mind to substitute `book` for `website` if you are authoring a book. - ### Favicon The favicon for your site provides an icon for browser tabs and other sites that link to yours. Use the `favicon` option to provide the path to a favicon image. For example: @@ -213,6 +213,8 @@ image: false ## Analytics +If you are authoring a book, remember to set the analytics keys below under `book` instead of `website` (see the note at the top of this page). + ### Plausible Analytics [Plausible Analytics](https://plausible.io/) is a lightweight, open-source, and privacy-friendly alternative to Google Analytics. Plausible is designed with privacy as a core principle: it doesn't use cookies, is GDPR compliant by default, and all data is processed anonymously.