refactor and cleanup

withstudiocms · Dec 14, 2024 · 85d8ede · 85d8ede
1 parent e3db1b7
commit 85d8ede
Show file tree

Hide file tree

Showing 23 changed files with 178 additions and 384 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -19,6 +19,7 @@
     "prototools",
     "robotstxt",
     "studiocms",
+    "twoslash",
     "withstudiocms"
   ]
 }
diff --git a/docs/src/content/docs/config-reference/included-integrations/index.mdx b/docs/src/content/docs/config-reference/included-integrations/index.mdx
@@ -15,33 +15,14 @@ import { defineStudioCMSConfig } from 'studiocms';
 // ---cut---
 export default defineStudioCMSConfig({
   includedIntegrations: {
-    useAstroRobots: true,
-    astroRobotsConfig: {},
-    useInoxSitemap: true,
+    robotsTXT: true,
   },
 })
 ```
 
-### `useAstroRobots`
+### `robotsTXT`
 
-- **Type:** `boolean | undefined`
+- **Type:** `boolean` | `RobotsConfig{}` | `undefined`
 - **Default:** `true`
 
-Allows the user to enable/disable the use of the StudioCMS Custom `astro-robots-txt` Integration.
-
-### `astroRobotsConfig`
-
-- **Type:** `RobotsConfig{} | undefined{}`
-
-Allows you to modify the default behaviour of the this Integration. For more information on this Integration please visit the [Astro Robots Integration](https://www.npmjs.com/package/astro-robots).
-
-### `useInoxSitemap` 
-
-#### TEMPORARILY DISABLED
-
-If you would like to still use the Inox-tools Sitemap Plugin, you can manually add it to your project's Integrations.
-
-- **Type:** `boolean | undefined`
-- **Default:** `true`
-
-Allows the user to enable/disable the use of the Inox-tools Sitemap Plugin. For more information on this Integration please visit the [Inox-tools Sitemap Integration](https://inox-tools.vercel.app/sitemap-ext).
+Allows the user to enable/disable the use of the StudioCMS Custom `astro-robots-txt` Integration. For more information on this Integration please visit the [Astro Robots Integration](https://www.npmjs.com/package/astro-robots).
diff --git a/docs/src/content/docs/config-reference/renderer-config/index.mdx b/docs/src/content/docs/config-reference/renderer-config/index.mdx
@@ -12,10 +12,10 @@ import ReadMore from '~/components/ReadMore.astro';
 
 The Markdown Content Renderer to use for rendering pages within StudioCMS
 
-- **Type:** `'marked'` | `'markdoc'` | `'astro'` | `'mdx'` | `CustomRenderer`
-- **Default:** `'marked'`
+- **Type:** `'astro'` | `'markdoc'` | `'mdx'` | `CustomRenderer`
+- **Default:** `'astro'`
 
-`renderer` determines how Markdown content should be rendered in `studioCMS`. This is used to setup your content data. The default value is `marked` but you can also use `markdoc` or `astro` which uses Astro's built-in Remark processor.
+`renderer` determines how Markdown content should be rendered in `studioCMS`. This is used to setup your content data. The default value is `astro` which uses the Astro built-in markdown processor but you can also use `markdoc`, `mdx` or define a Custom Renderer.
 
 ### Usage
 
@@ -24,22 +24,13 @@ import { defineStudioCMSConfig } from 'studiocms';
 // ---cut---
 export default defineStudioCMSConfig({
   rendererConfig: {
-    renderer: 'marked',
-    markedConfig: {},
+    renderer: 'astro',
     markdocConfig: {},
     mdxConfig: {},
   },
 })
 ```
 
-## `markedConfig`
-
-`markedConfig` is an object that is used to determine how content should be rendered in the `studioCMS`. This is used to setup your content data.
-
-### Usage
-
-<ReadMore>[See `markedConfig` for full options](/config-reference/marked-config)</ReadMore>
-
 ## `markdocConfig`
 
 <ReadMore>`markdocConfig` is an object that is used to determine how content should be rendered in `studiocms` while using the MarkDoc renderer.</ReadMore>

diff --git a/docs/src/content/docs/config-reference/renderer-config/markdoc-config.mdx b/docs/src/content/docs/config-reference/renderer-config/markdoc-config.mdx
@@ -30,7 +30,7 @@ This property has the following options:
 
 ### `renderType`
 
-- **Type:** `'html' | 'react-static' | markdocRenderer`
+- **Type:** `'html' | 'react-static' | MarkdocRenderer`
 
 The MarkDoc content renderer type to use for rendering pages and posts can be `html`, `react-static` or a custom markdocRenderer.
 

diff --git a/docs/src/content/docs/config-reference/renderer-config/marked-config.mdx b/docs/src/content/docs/config-reference/renderer-config/marked-config.mdx