Skip to content

Commit

Permalink
Use 4 spaces to indent nested lists in MD so MkDocs can render them c…
Browse files Browse the repository at this point in the history
…orrectly (#486)
  • Loading branch information
adamkudrna committed Oct 18, 2023
1 parent bc1744f commit 196518d
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 14 deletions.
5 changes: 4 additions & 1 deletion .markdownlint.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

{
"default": true,
"MD033": false, // Allow inline JSX.
"MD007": { // Unordered list indentation
"indent": 4 // 4 spaces so MkDocs can render nested lists correctly
},
"MD033": false, // Allow inline JSX and custom web components
"MD024": false, // Allow duplicate headings
"line-length": {
"code_block_line_length": 120,
Expand Down
8 changes: 4 additions & 4 deletions src/components/Button/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -433,10 +433,10 @@ Where:
- `<INTERACTION STATE>` is one of `default`, `hover`, `active`, or `disabled`
(the last one being optional),
- `<PROPERTY>` is one of:
- `color`, `border-color`, `background`, or `box-shadow` for the `filled`
priority,
- `color`, `border-color`, or `background` for the `outline` priority,
- `color` or `background` for the `flat` priority.
- `color`, `border-color`, `background`, or `box-shadow` for the `filled`
priority,
- `color`, `border-color`, or `background` for the `outline` priority,
- `color` or `background` for the `flat` priority.

### Theming Sizes

Expand Down
4 changes: 2 additions & 2 deletions src/components/Card/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ See [API](#api) for all available options.
Card is decomposed into the following components:

- [Card](#api)
- [CardBody](#cardbody)
- [CardFooter](#cardfooter)
- [CardBody](#cardbody)
- [CardFooter](#cardfooter)

Aside from the [CardBody](#cardbody) element, you can add a
[CardFooter](#cardfooter) to better separate your card's actions from the rest
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 @@ -105,13 +105,13 @@ See [API](#api) for all available options.
Modal is decomposed into the following components:

- Modal
- [ModalHeader](#modalheader)
- ModalTitle
- ModalCloseButton
- [ModalBody](#modalbody)
- ModalContent
(may be wrapped with [ScrollView](/components/ScrollView))
- [ModalFooter](#modalfooter)
- [ModalHeader](#modalheader)
- ModalTitle
- ModalCloseButton
- [ModalBody](#modalbody)
- ModalContent
(may be wrapped with [ScrollView](/components/ScrollView))
- [ModalFooter](#modalfooter)

Using different combinations, you can compose different kinds of modals,
e.g. dialog modal, blocking modal, scrollable modal, etc.
Expand Down

0 comments on commit 196518d

Please sign in to comment.