docs: update docs for v1.4.0

composer.json

@@ -2,7 +2,7 @@
   "name": "johannschopplich/kirby-seo-audit",
   "description": "State-of-the-art SEO analysis for Kirby CMS",
   "type": "kirby-plugin",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "license": "PROPRIETARY",
   "homepage": "https://kirbyseo.com",
   "authors": [

content/1.docs/1.get-started/1.index.md

@@ -28,4 +28,4 @@ You don't have to configure anything else! Open your Kirby Panel and you should
 ::preview{src="/img/seo-audit-section.png"}
 ::
 
-Click the **Analyze** button to generate a report for the current page. The report will evaluate the SEO quality of the page and provide actionable insights to improve it.
+Click the **Analyze** button to perform SEO checks on the current page. The report will evaluate the SEO quality of the page and provide actionable insights to improve it.

content/1.docs/1.get-started/2.configuration.md

@@ -46,12 +46,36 @@ sections:
 If no `keyphraseField` is defined, all keyphrase assessments will be skipped, unless you explicitly enable them in the `assessments` property.
 ::
 
+### `synonymsField` :u-badge{label="String" class="align-middle ml-2 !rounded-full" variant="subtle"}
+
+Add synonyms to your keyphrase to avoid repeating the same keyphrase over and over again. Not only will readers like this, but it will also help Google to better understand what your content is about.
+
+Set the `synonymsField` property to select which field of the current page model contains the synonyms.
+
+```yaml [pages/default.yml]
+sections:
+  content:
+    type: fields
+    fields:
+      metaKeywords:
+        label: Meta Keywords
+        type: text
+      synonyms:
+        label: Keyword Synonyms
+        type: tags
+  seo:
+    seoInsights:
+      type: seo-insights
+      keyphraseField: metaKeywords
+      synonymsField: synonyms
+```
+
 ### `assessments` :u-badge{label="Array" class="align-middle ml-2 !rounded-full" variant="subtle"}
 
 Kirby SEO Audit comes with a set of assessments that are used to analyze the content of a page. You can enable or disable individual assessments by setting the `assessments` property. By default, all assessments are enabled.
 
 ::callout{icon="i-ri-information-line"}
-For a list of available assessments, see the [Assessments Guide](/docs/guide/assessments) page.
+For a list of available SEO checks, see the [Assessments Guide](/docs/guide/assessments) page.
 ::
 
 An example configuration that only includes a subset of assessments:
@@ -80,7 +104,7 @@ links: false
 
 ### `persisted` :u-badge{label="Boolean" class="align-middle ml-2 !rounded-full" variant="subtle"}
 
-Decide if the report should be saved to local storage or not. By default, the generated SEO audit will be saved to (and read from) the local storage of the browser. This allows the editor to close the panel and return to the SEO audit later without having to re-run the analysis.
+Decide if the audit should be saved to local storage or not. By default, the generated SEO report will be saved to (and read from) the local storage of the browser. This allows the editor to close the panel and return to the SEO audit later without having to re-run the analysis.
 
 To disable persisting the analysis, set the `persisted` property to `false`:
 

content/1.docs/2.guide/1.assessments.md

@@ -1,14 +1,29 @@
 ---
-title: Assessments
-description: Pick from 27 different SEO assessments to include in the SEO report.
+title: SEO Checks
+description: Pick from 30+ different SEO assessments to include in the SEO report.
 ---
 
-You can choose from 27 different SEO assessments that can be included in the SEO report. These assessments are based on the analysis of the HTML content of a given page by [`yoastseo`](https://www.npmjs.com/package/yoastseo) JavaScript package, which is part of the official [Yoast SEO for WordPress](https://yoast.com/wordpress/plugins/seo/) plugin.
+## Overview
+
+Currently, Kirby SEO Audit comes with 30 different SEO checks that can be included in the SEO report:
+
+- 27 assessments are based on the [`yoastseo`](https://www.npmjs.com/package/yoastseo) JavaScript package, which is part of the official [Yoast SEO for WordPress](https://yoast.com/wordpress/plugins/seo/) plugin.
+- 3 assessments are provided by the Kirby SEO Audit plugin.
 
 ::callout{icon="i-ri-information-line"}
-We are working on adding more assessments that don't rely on Yoast SEO's analysis. If you have any suggestions or feedback, please [let us know](/contact).
+We are working on adding more assessments that don't rely on Yoast SEO's analysis. If you have any suggestions what to add, please [let us know](/contact).
 ::
 
+### Kirby SEO Audit Assessments
+
+The following assessments are provided by the Kirby SEO Audit plugin:
+
+- **Alt attribute**: Checks whether all images have an `alt` attribute.
+- **Single H1**: Checks whether the content contains a H1 heading.
+- **Heading structure order**: Checks whether the headings (H1 to H6) follow a proper sequential order.
+
+### Yoast SEO Assessments
+
 Kirby SEO Audit uses Yoast SEO's default metrics and provides its own methods for calculating title length, for example. The following scores are available:
 
 - Flesch Reading Ease
@@ -39,7 +54,7 @@ Kirby SEO Audit uses Yoast SEO's default metrics and provides its own methods fo
 - Title Keyword
 - Url Keyword
 
-## Individual Reports
+## Custom Reports
 
 By default, all assessments are enabled. Pick which assessments to include in the SEO report by adding a `assessments` field to the page's options in the blueprint:
 

content/1.docs/2.guide/2.audit-url.md

@@ -3,7 +3,7 @@ title: Audit URL
 description: Customize the target URL used to generate the SEO report for.
 ---
 
-You might be wondering how the Kirby SEO Audit plugin knows which URL to audit? The answer is simple: it retrieves the `previewUrl` of the current Kirby page model. This means that the URL used to generate the SEO report is the same as the one opened by clicking the preview button in the Panel. Which means that draft pages can be audited as well.
+You might be wondering how the Kirby SEO Audit plugin knows which URL to process? The answer is simple: it retrieves the `previewUrl` of the current Kirby page model. This means that the URL used to generate the SEO report is the same as the one opened by clicking the preview button in the Panel. Which means that draft pages can be SEO-checked as well.
 
 The plugin fetches the HTML content of the preview URL, performs the SEO evaluation on it and generates the SEO report.
 

content/buy.yml

@@ -29,7 +29,7 @@ faq:
       content: After your purchase, you will receive an email with a download link to a ZIP file containing the plugin. Install the plugin into your Kirby project, create a new section of type `seo-audit` in any page blueprint and you're ready to generate SEO audits for your pages.
       defaultOpen: true
     - label: What if the SEO report is incorrect?
-      content: We don't guarantee that the audits are 100% accurate. The audits are based on the [`yoastseo`](https://www.npmjs.com/package/yoastseo) JavaScript package. We are not responsible for any incorrect audits. Please test the plugin in the [playground](/playground) before purchasing.
+      content: We don't guarantee that the SEO checks are 100% accurate. Some assessments are based on the [`yoastseo`](https://www.npmjs.com/package/yoastseo) JavaScript package. We are not responsible for any incorrect audits provided by it. However, we are constantly improving the plugin by adding new assessments. Please test the plugin in the [playground](/playground) before purchasing.
     - label: Which Kirby versions are supported?
       content: Kirby SEO Audit is only compatible with Kirby 4.
     - label: What does “Unlimited minor & patch updates” include?

content/changelog/v1.4.0.md

@@ -0,0 +1,12 @@
+---
+title: v1.4.0
+date: 2024-03-09
+---
+
+**🚀 Features**
+
+- [`synonymsField`](/docs/get-started/configuration#synonymsfield) option to add synonyms to the page's keyword or keyphrase.
+- [Custom SEO checks](/docs/guide/assessments#kirby-seo-audit-assessments) that complement the default assessments provided by Yoast SEO.
+  - **Alt attribute**: Checks whether all images have an `alt` attribute.
+  - **Single H1**: Checks whether the content contains a H1 heading.
+  - **Heading structure order**: Checks whether the headings (H1 to H6) follow a proper sequential order.

content/index.yml

@@ -8,7 +8,7 @@ hero:
     icon: i-ri-emotion-line
   orientation: horizontal
   title: '<span class="text-primary">SEO Analysis</span><br> With One Click'
-  description: Kirby SEO Audit offers the power of Yoast SEO in a Kirby Panel section. Analyze your pages, improve your content, and boost your rankings.
+  description: Kirby SEO Audit offers the power of Yoast SEO in a Kirby Panel section. Improve your content and boost your rankings by checking your pages for SEO issues.
   links:
     - label: Generate Your SEO Report
       to: /playground
@@ -22,7 +22,7 @@ sections:
     class: "dark:bg-gradient-to-b from-gray-900 to-gray-950/50 dark:lg:bg-none dark:lg:bg-gray-950/50"
     cards:
       - title: The Power of Yoast SEO
-        description: The SEO report is close to the result of Yoast SEO, which is helpful when migrating from WordPress to Kirby.
+        description: The SEO checks are based on Yoast SEO, which is helpful when migrating from WordPress to Kirby.
         icon: i-ri-wordpress-fill
         to: /guide/assessments
         class: col-span-7 row-span-3
@@ -31,13 +31,13 @@ sections:
         icon: i-ri-plug-line
         to: /get-started/installation
         class: "col-span-5 row-span-5 lg:mb-10"
-      - title: Customizable Reports
-        description: Choose from 27 different SEO assessments like keyword density or meta description length. We will add more SEO checks over time.
-        icon: i-ri-file-list-3-line
+      - title: 30+ SEO Checks
+        description: Choose which checks you want to perform, such as keyword density or meta description length. We are constantly adding new checks.
+        icon: i-ri-checkbox-circle-line
         to: /docs/get-started/configuration#assessments
         class: col-span-7 row-span-3
       - title: Privacy First
-        description: No external API calls, no hidden costs. The SEO audit is generated client-side in your Kirby Panel!
+        description: No external API calls, no hidden costs. The SEO checks are performed client-side in your Kirby Panel!
         to: /playground
         icon: i-ri-file-lock-line
         class: "col-span-5 row-span-5 lg:-mt-10 lg:mb-20"

nuxt.config.ts

@@ -4,7 +4,6 @@ export default defineNuxtConfig({
   modules: [
     "@nuxt/content",
     "@nuxt/image",
-    // "@nuxt/fonts",
     "@nuxt/ui",
     "@vueuse/nuxt",
     "nuxt-og-image",

package.json

@@ -21,7 +21,6 @@
     "@iconify-json/heroicons": "^1.1.20",
     "@iconify-json/ri": "^1.1.20",
     "@nuxt/content": "^2.12.0",
-    "@nuxt/fonts": "^0.0.1",
     "@nuxt/image": "^1.4.0",
     "@nuxt/ui-pro": "^1.0.2",
     "@types/node": "^20.11.25",