From d916466fdf21e7c77ea11aadb563d4fb9b8a81c6 Mon Sep 17 00:00:00 2001 From: Jeff Chew Date: Thu, 2 Jan 2025 14:08:28 -0500 Subject: [PATCH] docs(developer): fix formatting --- src/components/MdxIcon/index.js | 1 - .../all-about-carbon/who-uses-carbon.mdx | 5 +-- .../developing/dev-resources/community.mdx | 34 ++++++++----------- .../developing/dev-resources/official.mdx | 17 ++++------ .../frameworks-community/angular.mdx | 14 ++------ .../developing/frameworks-community/lwc.mdx | 14 ++------ .../frameworks-community/other-frameworks.mdx | 14 ++------ .../frameworks-community/svelte.mdx | 14 ++------ .../frameworks-community/vanilla.mdx | 14 ++------ .../developing/frameworks-community/vue.mdx | 14 ++------ src/pages/developing/frameworks/react.mdx | 10 ++---- .../developing/frameworks/web-components.mdx | 10 ++---- src/pages/developing/get-started.mdx | 17 +++++----- 13 files changed, 57 insertions(+), 121 deletions(-) diff --git a/src/components/MdxIcon/index.js b/src/components/MdxIcon/index.js index 3ba3f625cd7..a8a2166948c 100644 --- a/src/components/MdxIcon/index.js +++ b/src/components/MdxIcon/index.js @@ -22,7 +22,6 @@ import vue from './icons/vue.png'; import webcomponents from './icons/webcomponents.png'; import yourlearning from './icons/yourlearning.svg'; - const localIcons = { angular, ase, diff --git a/src/pages/all-about-carbon/who-uses-carbon.mdx b/src/pages/all-about-carbon/who-uses-carbon.mdx index a1adc046fa8..d705cc4266b 100755 --- a/src/pages/all-about-carbon/who-uses-carbon.mdx +++ b/src/pages/all-about-carbon/who-uses-carbon.mdx @@ -142,8 +142,9 @@ Here are some ways developers can begin engaging with Carbon. - Visit [Developing > Get started](/developing/get-started/) and install your framework of choice. -- Visit [Developer resources](/developing/dev-resources/official/) to find Carbon tools, - as well as our GitHub repos and Storybooks for your framework of choice. +- Visit [Developer resources](/developing/dev-resources/official/) to find + Carbon tools, as well as our GitHub repos and Storybooks for your framework of + choice. #### Connect with the team diff --git a/src/pages/developing/dev-resources/community.mdx b/src/pages/developing/dev-resources/community.mdx index 29cb69e003f..92c97cd2a8d 100644 --- a/src/pages/developing/dev-resources/community.mdx +++ b/src/pages/developing/dev-resources/community.mdx @@ -3,11 +3,7 @@ title: Developer resources description: Here you'll find Carbon tools, as well as our GitHub repos and Storybooks for your framework of choice. -tabs: - [ - 'Official', - 'Community', - ] +tabs: ['Official', 'Community'] --- @@ -106,20 +102,20 @@ your framework of choice. ## Tutorials - - - - - - - - - - + + + + + + + + + + ## Tools diff --git a/src/pages/developing/dev-resources/official.mdx b/src/pages/developing/dev-resources/official.mdx index 5d3a0c77963..f7f236e0abe 100644 --- a/src/pages/developing/dev-resources/official.mdx +++ b/src/pages/developing/dev-resources/official.mdx @@ -3,11 +3,7 @@ title: Developer resources description: Here you'll find Carbon tools, as well as our GitHub repos and Storybooks for your framework of choice. -tabs: - [ - 'Official', - 'Community', - ] +tabs: ['Official', 'Community'] --- @@ -111,13 +107,13 @@ your framework of choice. ## Tutorials - + - + subTitle="Carbon React tutorial" + href="/developing/react-tutorial/overview/"> + - + ## Tools @@ -147,4 +143,3 @@ your framework of choice. - diff --git a/src/pages/developing/frameworks-community/angular.mdx b/src/pages/developing/frameworks-community/angular.mdx index 503b4cdaa57..5ca845cfc18 100644 --- a/src/pages/developing/frameworks-community/angular.mdx +++ b/src/pages/developing/frameworks-community/angular.mdx @@ -2,17 +2,9 @@ title: Frameworks (community) description: The Carbon Design System is built with official support for React and Web - Components. Community support exists for other frameworks like Angular, vanilla JS, - Vue, Svelte, and Lightning Web Components. -tabs: - [ - 'Angular', - 'Vue', - 'Svelte', - 'LWC', - 'Vanilla', - 'Other frameworks', - ] + Components. Community support exists for other frameworks like Angular, + vanilla JS, Vue, Svelte, and Lightning Web Components. +tabs: ['Angular', 'Vue', 'Svelte', 'LWC', 'Vanilla', 'Other frameworks'] --- diff --git a/src/pages/developing/frameworks-community/lwc.mdx b/src/pages/developing/frameworks-community/lwc.mdx index 522c108e60b..e4f279b92cf 100644 --- a/src/pages/developing/frameworks-community/lwc.mdx +++ b/src/pages/developing/frameworks-community/lwc.mdx @@ -2,17 +2,9 @@ title: Frameworks (community) description: The Carbon Design System is built with official support for React and Web - Components. Community support exists for other frameworks like Angular, vanilla JS, - Vue, Svelte, and Lightning Web Components. -tabs: - [ - 'Angular', - 'Vue', - 'Svelte', - 'LWC', - 'Vanilla', - 'Other frameworks', - ] + Components. Community support exists for other frameworks like Angular, + vanilla JS, Vue, Svelte, and Lightning Web Components. +tabs: ['Angular', 'Vue', 'Svelte', 'LWC', 'Vanilla', 'Other frameworks'] --- diff --git a/src/pages/developing/frameworks-community/other-frameworks.mdx b/src/pages/developing/frameworks-community/other-frameworks.mdx index ecafabab611..df9b41ecebc 100755 --- a/src/pages/developing/frameworks-community/other-frameworks.mdx +++ b/src/pages/developing/frameworks-community/other-frameworks.mdx @@ -2,17 +2,9 @@ title: Frameworks (community) description: The Carbon Design System is built with official support for React and Web - Components. Community support exists for other frameworks like Angular, vanilla JS, - Vue, Svelte, and Lightning Web Components. -tabs: - [ - 'Angular', - 'Vue', - 'Svelte', - 'LWC', - 'Vanilla', - 'Other frameworks', - ] + Components. Community support exists for other frameworks like Angular, + vanilla JS, Vue, Svelte, and Lightning Web Components. +tabs: ['Angular', 'Vue', 'Svelte', 'LWC', 'Vanilla', 'Other frameworks'] --- diff --git a/src/pages/developing/frameworks-community/svelte.mdx b/src/pages/developing/frameworks-community/svelte.mdx index 9cb638787d8..5eb03f4c8f8 100644 --- a/src/pages/developing/frameworks-community/svelte.mdx +++ b/src/pages/developing/frameworks-community/svelte.mdx @@ -2,17 +2,9 @@ title: Frameworks (community) description: The Carbon Design System is built with official support for React and Web - Components. Community support exists for other frameworks like Angular, vanilla JS, - Vue, Svelte, and Lightning Web Components. -tabs: - [ - 'Angular', - 'Vue', - 'Svelte', - 'LWC', - 'Vanilla', - 'Other frameworks', - ] + Components. Community support exists for other frameworks like Angular, + vanilla JS, Vue, Svelte, and Lightning Web Components. +tabs: ['Angular', 'Vue', 'Svelte', 'LWC', 'Vanilla', 'Other frameworks'] --- diff --git a/src/pages/developing/frameworks-community/vanilla.mdx b/src/pages/developing/frameworks-community/vanilla.mdx index 5eb4e8a7251..cfc5827362c 100755 --- a/src/pages/developing/frameworks-community/vanilla.mdx +++ b/src/pages/developing/frameworks-community/vanilla.mdx @@ -2,17 +2,9 @@ title: Frameworks (community) description: The Carbon Design System is built with official support for React and Web - Components. Community support exists for other frameworks like Angular, vanilla JS, - Vue, Svelte, and Lightning Web Components. -tabs: - [ - 'Angular', - 'Vue', - 'Svelte', - 'LWC', - 'Vanilla', - 'Other frameworks', - ] + Components. Community support exists for other frameworks like Angular, + vanilla JS, Vue, Svelte, and Lightning Web Components. +tabs: ['Angular', 'Vue', 'Svelte', 'LWC', 'Vanilla', 'Other frameworks'] --- diff --git a/src/pages/developing/frameworks-community/vue.mdx b/src/pages/developing/frameworks-community/vue.mdx index 89d8bd7eeb9..c47015bb814 100644 --- a/src/pages/developing/frameworks-community/vue.mdx +++ b/src/pages/developing/frameworks-community/vue.mdx @@ -2,17 +2,9 @@ title: Frameworks (community) description: The Carbon Design System is built with official support for React and Web - Components. Community support exists for other frameworks like Angular, vanilla JS, - Vue, Svelte, and Lightning Web Components. -tabs: - [ - 'Angular', - 'Vue', - 'Svelte', - 'LWC', - 'Vanilla', - 'Other frameworks', - ] + Components. Community support exists for other frameworks like Angular, + vanilla JS, Vue, Svelte, and Lightning Web Components. +tabs: ['Angular', 'Vue', 'Svelte', 'LWC', 'Vanilla', 'Other frameworks'] --- diff --git a/src/pages/developing/frameworks/react.mdx b/src/pages/developing/frameworks/react.mdx index 001bd478410..e5fd1914033 100755 --- a/src/pages/developing/frameworks/react.mdx +++ b/src/pages/developing/frameworks/react.mdx @@ -2,13 +2,9 @@ title: Frameworks (official) description: The Carbon Design System is built with official support for React and Web - Components. Community support exists for other frameworks like Angular, vanilla JS, - Vue, Svelte, and Lightning Web Components. -tabs: - [ - 'React', - 'Web Components', - ] + Components. Community support exists for other frameworks like Angular, + vanilla JS, Vue, Svelte, and Lightning Web Components. +tabs: ['React', 'Web Components'] --- diff --git a/src/pages/developing/frameworks/web-components.mdx b/src/pages/developing/frameworks/web-components.mdx index 714bcd589f4..542373e1a7f 100644 --- a/src/pages/developing/frameworks/web-components.mdx +++ b/src/pages/developing/frameworks/web-components.mdx @@ -2,13 +2,9 @@ title: Frameworks (official) description: The Carbon Design System is built with official support for React and Web - Components. Community support exists for other frameworks like Angular, vanilla JS, - Vue, Svelte, and Lightning Web Components. -tabs: - [ - 'React', - 'Web Components', - ] + Components. Community support exists for other frameworks like Angular, + vanilla JS, Vue, Svelte, and Lightning Web Components. +tabs: ['React', 'Web Components'] --- diff --git a/src/pages/developing/get-started.mdx b/src/pages/developing/get-started.mdx index e7340920be7..a8252698db6 100644 --- a/src/pages/developing/get-started.mdx +++ b/src/pages/developing/get-started.mdx @@ -27,24 +27,25 @@ checklist of everything you need to get up and running. ### Install your framework of choice The Carbon Design System is built with official support for React and Web -Components. Community support exists for other frameworks like Angular, vanilla JS, -Vue, Svelte, and Lightning Web Components. Head over to +Components. Community support exists for other frameworks like Angular, vanilla +JS, Vue, Svelte, and Lightning Web Components. Head over to [Frameworks](/developing/frameworks/react) for all the information you need to get started. ### Check out our developer resources -In [Developer resources](/developing/dev-resources/official/), you’ll find Carbon tools, -as well as our GitHub repos and Storybooks for your framework of choice. +In [Developer resources](/developing/dev-resources/official/), you’ll find +Carbon tools, as well as our GitHub repos and Storybooks for your framework of +choice. ## Additional guidance ### Take a tutorial -We offer tutorials in React using Next.js, with community contributed tutorials for -Angular and Vue, to guide you in creating an app with the Carbon Design System. We’ll -teach you the ins and outs of using Carbon components, and introduce web development -best practices along the way. +We offer tutorials in React using Next.js, with community contributed tutorials +for Angular and Vue, to guide you in creating an app with the Carbon Design +System. We’ll teach you the ins and outs of using Carbon components, and +introduce web development best practices along the way.