From dfcb3b996476154d386a19201844da50411889fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bed=C5=99ich=20Schindler?= Date: Fri, 1 Sep 2023 14:57:18 +0200 Subject: [PATCH] Update documentation to fix markdownlint errors (#358) --- src/components/Card/README.md | 4 ++-- src/components/FormLayout/README.md | 2 +- src/components/Modal/README.md | 14 +++++++------- src/components/Toolbar/README.md | 3 --- src/docs/css-helpers/colors.md | 3 --- 5 files changed, 10 insertions(+), 16 deletions(-) diff --git a/src/components/Card/README.md b/src/components/Card/README.md index 891ccb67..32da3f8e 100644 --- a/src/components/Card/README.md +++ b/src/components/Card/README.md @@ -269,7 +269,7 @@ its accessibility. ### CardBody -Space your content with CardBody. See [Card Composition](#card-composition) for +Space your content with CardBody. See [Composition](#composition) for all details. @@ -277,7 +277,7 @@ all details. ### CardFooter Separate your card actions with CardFooter. See -[Card Composition](#card-composition) for all details. +[Composition](#composition) for all details. diff --git a/src/components/FormLayout/README.md b/src/components/FormLayout/README.md index 5c45e570..a44536db 100644 --- a/src/components/FormLayout/README.md +++ b/src/components/FormLayout/README.md @@ -187,7 +187,7 @@ work together yet 🎩. ## Custom Fields You can even place any content you need into the FormLayout — just wrap it with -the [FormLayoutCustomField](#formlayoutcustomfield) component. This layout +the FormLayoutCustomField component. This layout helper ensures your content is properly spaced and aligned with to other FormLayout elements. FormLayoutCustomFields are designed to work solely inside the FormLayout component. diff --git a/src/components/Modal/README.md b/src/components/Modal/README.md index 283875a0..edf738bd 100644 --- a/src/components/Modal/README.md +++ b/src/components/Modal/README.md @@ -98,14 +98,14 @@ See [API](#api) for all available options. Modal is decomposed into the following components: -- [Modal](#api) - - [ModalHeader](#modalheader_1) - - [ModalTitle](#modaltitle) - - [ModalCloseButton](#modalclosebutton) - - [ModalBody](#modalbody_1) - - [ModalContent](#modalcontent) +- Modal + - [ModalHeader](#modalheader) + - ModalTitle + - ModalCloseButton + - [ModalBody](#modalbody) + - ModalContent (may be wrapped with [ScrollView](/components/ScrollView)) - - [ModalFooter](#modalfooter_1) + - [ModalFooter](#modalfooter) Using different combinations, you can compose different kinds of modals, e.g. dialog modal, blocking modal, scrollable modal, etc. diff --git a/src/components/Toolbar/README.md b/src/components/Toolbar/README.md index b36bccbe..b44f4b49 100644 --- a/src/components/Toolbar/README.md +++ b/src/components/Toolbar/README.md @@ -353,10 +353,7 @@ A wrapper for individual toolbar items. | `--rui-Toolbar__gap` | Gap between toolbar items | | `--rui-Toolbar__gap--dense` | Dense gap between toolbar items | -[inline-elements]: https://developer.mozilla.org/en-US/docs/Web/HTML/Inline_elements -[block-elements]: https://developer.mozilla.org/en-US/docs/Web/HTML/Inline_elements [grid]: /components/Grid -[spacing]: /css-helpers/spacing [text]: /components/Text [React synthetic events]: https://reactjs.org/docs/events.html [div]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div#attributes diff --git a/src/docs/css-helpers/colors.md b/src/docs/css-helpers/colors.md index 39e2925b..b456c967 100644 --- a/src/docs/css-helpers/colors.md +++ b/src/docs/css-helpers/colors.md @@ -1,8 +1,5 @@ # Colors -import { Playground } from 'docz' -import { Placeholder } from '../_components/Placeholder/Placeholder' - Helpers for text and background. ## Text Colors