Merge pull request #1422 from mattstein/chore/v3-docs-update

docs: Update v3 docs

docs/.textlintrc.js

@@ -11,7 +11,23 @@ module.exports = {
             severity: 'warning'
         },
         terminology: {
-            terms: `${__dirname}/.textlint.terms.json`
+            terms: `${__dirname}/.textlint.terms.json`,
+            exclude: [
+                "front[- ]end(\\w*)",
+                "back[- ]end(\\w*)",
+                "command ?line",
+                "PDF",
+                "PNG",
+                "JPG",
+                "GIF",
+                "HTML",
+                "CSS",
+                "ID",
+                "Markdown",
+                "URL",
+                "walk[- ]through",
+                "web[- ]?site(s)?"
+            ]
         },
         'write-good': {
             severity: 'warning'

docs/docs/.vitepress/config.ts

@@ -29,19 +29,63 @@ export default defineConfig({
     lastUpdatedText: 'Last Updated',
     sidebar: [
       {
-        text: 'Topics',
+        text: 'Getting Started',
         items: [
-          {text: 'SEOmatic Plugin', link: '/'},
-          {text: 'SEOmatic Overview', link: '/overview.html'},
-          {text: 'Issues & Upgrading', link: '/issues.html'},
-          {text: 'SEO Resources', link: '/resources.html'},
-          {text: 'SEO Technologies', link: '/technologies.html'},
-          {text: 'Configuring SEOmatic', link: '/configuring.html'},
-          {text: 'SEOmatic Fields', link: '/fields.html'},
-          {text: 'Using SEOmatic', link: '/using.html'},
-          {text: 'Advanced Usage', link: '/advanced.html'},
+          {text: 'Features & Installation', link: '/'},
+          {text: 'Overview', link: '/overview'},
+          {text: 'Issues & Upgrading', link: '/issues'},
+          {text: 'What it Does', link: '/what-it-does'},
         ],
-      }
+      },
+      {
+        text: 'Using SEOmatic',
+        items: [
+          {
+            text: 'Configuration',
+            link: '/configuring/',
+            collapsed: true,
+            items: [
+              {text: 'Dashboard', link: '/configuring/dashboard'},
+              {text: 'Global SEO', link: '/configuring/global-seo'},
+              {text: 'Content SEO', link: '/configuring/content-seo'},
+              {text: 'Site Settings', link: '/configuring/site-settings'},
+              {text: 'Tracking Scripts', link: '/configuring/tracking-scripts'},
+              {text: 'Plugin Settings', link: '/configuring/plugin-settings'},
+              {text: 'Multi-Environment Config Settings', link: '/configuring/multi-environment'},
+              {text: 'Access Permissions', link: '/configuring/access-permissions'},
+            ]
+          },
+          {
+            text: 'Twig Templating',
+            link: '/using/',
+            collapsed: true,
+            items: [
+              {text: '???', link: '/using/empty-coalesce-operator'},
+              {text: 'seomatic.meta', link: '/using/meta-variables'},
+              {text: 'seomatic.site', link: '/using/site-variables'},
+              {text: 'seomatic.config', link: '/using/config-variables'},
+              {text: 'seomatic.helper', link: '/using/helper-functions'},
+              {text: 'seomatic.jsonLd', link: '/using/json-ld-meta'},
+              {text: 'seomatic.link', link: '/using/link-meta'},
+              {text: 'seomatic.script', link: '/using/script-meta'},
+              {text: 'seomatic.tag', link: '/using/tag-meta'},
+              {text: 'seomatic.title', link: '/using/title-meta'},
+              {text: 'Pagination', link: '/using/pagination'},
+              {text: 'Meta Containers', link: '/using/meta-containers'},
+            ]
+          },
+          {text: 'SEO Settings Field', link: '/fields'},
+          {text: 'Multi-Site', link: '/multi-site'},
+          {text: 'Google AMP', link: '/google-amp'},
+          {text: 'Advanced Usage', link: '/advanced'},
+        ],
+      },
+      {
+        text: 'SEO Reference',
+        items: [
+          {text: 'Resources', link: '/resources'},
+        ],
+      },
     ],
     nav: [
       {text: 'Home', link: 'https://nystudio107.com/plugins/seomatic'},

docs/docs/.vitepress/theme/UsedByLogos.vue

@@ -0,0 +1,22 @@
+<template>
+  <div class="used-by-logos">
+    <a href="https://moz.com/" target="_blank" rel="noopener">
+      <img src="./img/moz-logo.svg" aria-label="Moz logo" width="140" height="40" />
+    </a>
+    <a href="https://craftcms.com/" target="_blank" rel="noopener">
+      <img src="./img/craft-cms-logo.svg" aria-label="Craft CMS logo" width="220" height="55" />
+    </a>
+  </div>
+</template>
+
+<style scoped>
+.used-by-logos {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: center;
+}
+
+.used-by-logos a:not(:last-child) {
+  margin-right: 2rem;
+}
+</style>

docs/docs/.vitepress/theme/index.ts

@@ -3,6 +3,7 @@ import {h, watch} from 'vue'
 import './custom.css'
 
 import NYSLogo from './NYSLogo.vue';
+import UsedByLogos from './UsedByLogos.vue';
 
 // Could also come from .env
 const GA_ID = 'UA-69117511-1';
@@ -15,7 +16,9 @@ export default {
       }
     )
   },
-  enhanceApp: (ctx) => {
+  enhanceApp: ({ app, router }) => {
+    app.component('UsedByLogos', UsedByLogos);
+
     // Google analytics integration
     if (import.meta.env.PROD && GA_ID && typeof window !== 'undefined') {
       (function (i, s, o, g, r, a, m) {
@@ -33,7 +36,7 @@ export default {
       ga('create', GA_ID, 'auto')
       ga('set', 'anonymizeIp', true)
       // Send a page view any time the route changes
-      watch(ctx.router.route, (newValue, oldValue) => {
+      watch(router.route, (newValue, oldValue) => {
         ga('set', 'page', newValue.path)
         ga('send', 'pageview')
       })