Merge pull request #66 from Prisjakt/aj/cleanup-and-restructure

Update to docusaurus 3.0

Author: andrejohansson

docs/fields/offer/id.md

@@ -30,7 +30,7 @@ Identifier should be unique for every product and not be changed or re-used for
 - Only **ascii** characters
 - Trailing whitespace characters are not allowed
 - Allowed characters: All ascii characters
-- Disallowed characters: "!, +, @, #, $, %, ^, &, *, <, >, ;, :"
+- Disallowed characters: `!` `+` `@` `#` `$` `%` `^` `&` `*` `<` `>` `;` `:`
 
 
 ## Best Practices

docs/fields/offer/product_type.md

@@ -62,7 +62,7 @@ product_type -- can be used instead  --- google_product_category
 
 - Refrain from including categories such as "Apple," "Sale," or "Black Friday 2023."
 - If using a CSV file, do not use comma `,` within a single product_type entry. They will split the entry. For instance, `Home, Garden > Furniture > Living Room` will become two separate entries: `Home` and `Garden > Furniture > Living Room`.
-- When using XML, always use a distinct <product_type> tag for each category instead of combining them within one tag.
+- When using XML, always use a distinct &lt;product_type&rt; tag for each category instead of combining them within one tag.
 
 
 

docs/overview/getting-started.md

@@ -24,5 +24,5 @@ If you have [Google Merchant Product Feed](https://support.google.com/merchants/
 
 ## Check 3: Generate Your Own
 
-- [ ] Generate a [feed](/types-of-feeds/pull/feed.md) in [xml format](/docs/types-of-feeds/pull/file-formats/xml.md) using our [examples](/examples/all) and [field specifications](/fields)
+- [ ] Generate a [feed](/types-of-feeds/pull/feed.md) in [xml format](/docs/types-of-feeds/pull/file-formats/xml.md) using our [examples](/examples/offer/all) and [field specifications](/fields)
 - [ ] Large volumes? Generate a [delta feed](/types-of-feeds/pull/delta-feeds.md)

docs/terminology/required-vs-optional.mdx

@@ -13,7 +13,7 @@ import ChangeLog from '@site/src/components/changelog';
 
 There are some fields, we *simply cannot be without* such as a link to your offer, a price and an title. If any of these fields are missing, your **whole offer** will be omitted.
 
-The following fields are required for an offer to show, you can see an example of the minimal required fields in action [here](/examples/minimal)
+The following fields are required for an offer to show, you can see an example of the minimal required fields in action [here](/examples/offer/minimal)
 
 - [Availability](/fields/offer/availability.md)
 - [Condition](/fields/offer/condition.md)

docusaurus.config.js

@@ -1,8 +1,8 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const lightCodeTheme = require('prism-react-renderer').themes.github;
+const darkCodeTheme = require('prism-react-renderer').themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {

package.json

@@ -15,24 +15,24 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.3.1",
-    "@docusaurus/plugin-client-redirects": "2.3.1",
-    "@docusaurus/plugin-google-gtag": "^2.3.1",
-    "@docusaurus/preset-classic": "^2.3.1",
-    "@docusaurus/theme-mermaid": "^2.3.1",
-    "@mdx-js/react": "^1.6.22",
-    "clsx": "^1.2.1",
-    "docusaurus-lunr-search": "^2.3.2",
-    "eta": "^2.0.0",
-    "prism-react-renderer": "^1.3.5",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "react-markdown": "^8.0.4"
+    "@docusaurus/core": "^3.1.1",
+    "@docusaurus/plugin-client-redirects": "^3.1.1",
+    "@docusaurus/plugin-google-gtag": "^3.1.1",
+    "@docusaurus/preset-classic": "^3.1.1",
+    "@docusaurus/theme-mermaid": "^3.1.1",
+    "@mdx-js/react": "^3.0.1",
+    "clsx": "^2.1.0",
+    "docusaurus-lunr-search": "^3.3.2",
+    "eta": "^3.2.0",
+    "prism-react-renderer": "^2.3.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-markdown": "^9.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.3.1",
+    "@docusaurus/module-type-aliases": "^3.1.1",
     "@tsconfig/docusaurus": "^1.0.5",
-    "typescript": "^4.7.4"
+    "typescript": "^5.4.2"
   },
   "browserslist": {
     "production": [
@@ -47,6 +47,6 @@
     ]
   },
   "engines": {
-    "node": ">=16.14"
+    "node": ">=18.0"
   }
 }