Skip to content

Commit

Permalink
Update documentation to fix markdownlint errors (#358)
Browse files Browse the repository at this point in the history
  • Loading branch information
bedrich-schindler committed Sep 6, 2023
1 parent 05496a2 commit dfcb3b9
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 16 deletions.
4 changes: 2 additions & 2 deletions src/components/Card/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,15 +269,15 @@ 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.

<docoff-react-props src="/components/Card/CardBody.jsx"></docoff-react-props>

### CardFooter

Separate your card actions with CardFooter. See
[Card Composition](#card-composition) for all details.
[Composition](#composition) for all details.

<docoff-react-props src="/components/Card/CardFooter.jsx"></docoff-react-props>

Expand Down
2 changes: 1 addition & 1 deletion src/components/FormLayout/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions src/components/Modal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 0 additions & 3 deletions src/components/Toolbar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 0 additions & 3 deletions src/docs/css-helpers/colors.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Colors

import { Playground } from 'docz'
import { Placeholder } from '../_components/Placeholder/Placeholder'

Helpers for text and background.

## Text Colors
Expand Down

0 comments on commit dfcb3b9

Please sign in to comment.