From d8ad97a283d255e8d87c0af5c5cae7e4c6f2fd2a Mon Sep 17 00:00:00 2001 From: Eric Tuvesson Date: Tue, 17 Oct 2023 09:58:29 +0200 Subject: [PATCH] feat: Add SEO JS API (#41) --- javascript/reference/seo/README.md | 32 ++++++++++++++++++++++++++++++ sidebarsJavascript.js | 1 + 2 files changed, 33 insertions(+) create mode 100644 javascript/reference/seo/README.md diff --git a/javascript/reference/seo/README.md b/javascript/reference/seo/README.md new file mode 100644 index 0000000..4540c4c --- /dev/null +++ b/javascript/reference/seo/README.md @@ -0,0 +1,32 @@ +--- +hide_title: true +hide_table_of_contents: true +title: Noodl.SEO +--- + +# Noodl.SEO + +The **Noodl.SEO** API lets you change metatags and document titles without directly accessing the window object, this is required for server-side rendering where we don't have a window. + +:::info + +All of this is only available on the frontend. + +::: + +### Reference + +#### **`Noodl.SEO.setTitle(value)`** +This function updates the window title. + +#### **`Noodl.SEO.meta`** +Get all the metatags that is currently used. + +#### **`Noodl.SEO.clearMeta()`** +Clear all the metatags that currently exist. + +#### **`Noodl.SEO.getMeta(key)`** +Get a specific metatag by key. + +#### **`Noodl.SEO.setMeta(key, value)`** +Set a metatag with key and value. diff --git a/sidebarsJavascript.js b/sidebarsJavascript.js index f6e6f2c..d0de81b 100644 --- a/sidebarsJavascript.js +++ b/sidebarsJavascript.js @@ -32,6 +32,7 @@ const sidebars = { { type: 'doc', label: 'Files', id: 'reference/files/README' }, { type: 'doc', label: 'Navigation', id: 'reference/navigation/README' }, { type: 'doc', label: 'CloudFunctions', id: 'reference/cloudfunctions/README' }, + { type: 'doc', label: 'SEO', id: 'reference/seo/README' }, ], }, {