From 6bd93909e5b9ca7d6e31497a57101e21dbf9b516 Mon Sep 17 00:00:00 2001 From: Michael Glass Date: Fri, 1 Mar 2024 18:37:18 +0100 Subject: [PATCH] mdx example --- ...ing-started.tsx => 01-01-getting-started.mdx} | 16 +++++----------- ...2-installation.tsx => 01-02-installation.mdx} | 15 ++++----------- packages/website/src/content/getting-started.mdx | 5 +++++ 3 files changed, 14 insertions(+), 22 deletions(-) rename packages/website/src/content/{01-01-getting-started.tsx => 01-01-getting-started.mdx} (79%) rename packages/website/src/content/{01-02-installation.tsx => 01-02-installation.mdx} (87%) create mode 100644 packages/website/src/content/getting-started.mdx diff --git a/packages/website/src/content/01-01-getting-started.tsx b/packages/website/src/content/01-01-getting-started.mdx similarity index 79% rename from packages/website/src/content/01-01-getting-started.tsx rename to packages/website/src/content/01-01-getting-started.mdx index 547a46d2..2de24243 100644 --- a/packages/website/src/content/01-01-getting-started.tsx +++ b/packages/website/src/content/01-01-getting-started.mdx @@ -3,20 +3,14 @@ import { PageTitle } from "../components/PageTitle"; import { PageContent } from "../components/PageContent"; import { packageUrls } from "../constants"; -export const content = ` + + + + This is the official JavaScript SDK to communicate with conversational bots created using NLX Dialog Studio. It contains the following packages: * [@nlxai/chat-widget](${packageUrls.chatWidget}): the official out-of-the-box, themeable NLX widget. * [@nlxai/chat-react](${packageUrls.chatReact}): React custom hook for building chat widgets. * [@nlxai/chat-preact](${packageUrls.chatPreact}): Preact custom hook for building chat widgets. * [@nlxai/chat-core](${packageUrls.chatCore}): vanilla JavaScript SDK for creating fully custom chat widgets. * [@nlxai/voice-compass](${packageUrls.voiceCompass}): multimodal capabilities. -`; - -export const GettingStarted = () => { - return ( - <> - - - - ); -}; + diff --git a/packages/website/src/content/01-02-installation.tsx b/packages/website/src/content/01-02-installation.mdx similarity index 87% rename from packages/website/src/content/01-02-installation.tsx rename to packages/website/src/content/01-02-installation.mdx index 66f95d26..ec2a7969 100644 --- a/packages/website/src/content/01-02-installation.tsx +++ b/packages/website/src/content/01-02-installation.mdx @@ -3,7 +3,9 @@ import { PageTitle } from "../components/PageTitle"; import { PageContent } from "../components/PageContent"; import { umdScriptTags, packageUrls } from "../constants"; -export const content = ` + + + SDK packages can be installed as follows: ## Using script tags @@ -48,13 +50,4 @@ npm install @nlxai/chat-core # Voice Compass npm install @nlxai/voice-compass ~~~ -`; - -export const Installation = () => { - return ( - <> - - - - ); -}; + diff --git a/packages/website/src/content/getting-started.mdx b/packages/website/src/content/getting-started.mdx new file mode 100644 index 00000000..de7823e8 --- /dev/null +++ b/packages/website/src/content/getting-started.mdx @@ -0,0 +1,5 @@ + +## hello, world! + +this isn't a header: hi hi +