Skip to content

Commit c08c2e4

Browse files
author
Matthew Davidson
committed
Made some improvements to the readme / docs information architecture
1 parent 434b5fc commit c08c2e4

File tree

39 files changed

+69
-66
lines changed

39 files changed

+69
-66
lines changed

packages/bpk-component-autosuggest/readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
> Backpack autosuggest component.
44
5-
### Installation
5+
## Installation
66

77
```sh
88
npm install bpk-component-autosuggest --save-dev
99
```
1010

11-
### Usage
11+
## Usage
1212

1313
```js
1414
import React, { Component } from 'react';
@@ -108,7 +108,7 @@ class MyComponent extends Component {
108108
}
109109
```
110110

111-
### Props
111+
## Props
112112

113113
*BpkAutosuggest:*
114114

packages/bpk-component-badge/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default () => (
1919
);
2020
```
2121

22-
### Props
22+
## Props
2323

2424
| Property | PropType | Required | Default Value |
2525
| --------- | --------------- | -------- | ------------- |

packages/bpk-component-banner-alert/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export default () => (
2626
);
2727
```
2828

29-
### Props
29+
## Props
3030

3131
| Property | PropType | Required | Default Value |
3232
| ----------------- | -------------------- | -------- | ------------- |

packages/bpk-component-blockquote/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export default () => (
2323
);
2424
```
2525

26-
### Props
26+
## Props
2727

2828
| Property | PropType | Required | Default Value |
2929
| --------- | -------- | -------- | ------------- |

packages/bpk-component-breakpoint/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export default () => (
2121
);
2222
```
2323

24-
### Props
24+
## Props
2525

2626
| Property | PropType | Required | Default Value |
2727
| --------- | ------------------ | -------- | ------------- |

packages/bpk-component-button/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export default () => (
3333
);
3434
```
3535

36-
### Props
36+
## Props
3737

3838
| Property | PropType | Required | Default Value |
3939
| ----------- | -------- | -------- | ------------- |

packages/bpk-component-calendar/readme.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ withCalendarState(composeCalendar(
9898
))
9999
```
100100

101-
#### Building a custom calendar
101+
### Building a custom calendar
102102

103103
A custom calendar can be created by swapping out any default component for an alternative:
104104

@@ -148,7 +148,7 @@ withCalendarState(composeCalendar(
148148
> implements the same API (props see below) and provides all the relevant accessibility
149149
> properties, such as ARIA attributes and `tabIndex`.
150150
151-
### Props
151+
## Props
152152

153153
| Property | PropType | Required | Default Value |
154154
| --------------------- | -------------------- | -------- | ---------------- |
@@ -171,7 +171,7 @@ withCalendarState(composeCalendar(
171171

172172
Some of the more complex props and props for sub-components are detailed below.
173173

174-
#### BpkCalendarNav
174+
### BpkCalendarNav
175175

176176
The BpkCalendarNav component is used to change the month that is being displayed by using
177177
buttons and a select box.
@@ -186,7 +186,7 @@ buttons and a select box.
186186
| month | Date | true | - |
187187
| onMonthChange | func | false | null |
188188

189-
#### BpkCalendarGridHeader
189+
### BpkCalendarGridHeader
190190

191191
The BpkCalendarGridHeader component displays the header of `BpkCalendarGrid`, listing
192192
the days of the week. This is needed as a separate component, as the header should stay
@@ -199,7 +199,7 @@ in place while the rest of the grid transitions when changing months.
199199
| weekStartsOn | number | true | - |
200200
| showWeekendSeparator | bool | false | false |
201201

202-
#### BpkCalendarGrid
202+
### BpkCalendarGrid
203203

204204
The BpkCalendarGrid component displays a month as a table.
205205

@@ -223,7 +223,7 @@ The BpkCalendarGrid component displays a month as a table.
223223
| showWeekendSeparator | bool | false | true |
224224
| weekStartsOn | number | false | 1 |
225225

226-
#### BpkCalendarDate
226+
### BpkCalendarDate
227227

228228
The BpkCalendarDate component is used to render the content of a cell
229229
(a single day) inside the calendar grid.
@@ -241,9 +241,9 @@ The BpkCalendarDate component is used to render the content of a cell
241241
| onDateKeyDown | func | false | null |
242242
| preventKeyboardFocus | bool | false | true |
243243

244-
#### Prop details
244+
### Prop details
245245

246-
##### daysOfWeek
246+
#### daysOfWeek
247247

248248
An array of objects describing the days of the week:
249249

@@ -271,14 +271,14 @@ An array of objects describing the days of the week:
271271
]
272272
```
273273

274-
##### fixedWidth
274+
#### fixedWidth
275275

276276
If set to true (default), it sets a fixed width on the calendar container. This is necessary to support
277277
transitions and to create the right size for the Datepicker component.
278278

279279
If set to false, the calendar is of fluid width and will take up the space of its parent container.
280280

281-
##### formatDateFull
281+
#### formatDateFull
282282

283283
A function to format a full, human-readable date, for example: "Friday, 13th January 2017":
284284

@@ -288,7 +288,7 @@ import format from 'date-fns/format';
288288
const formatDateFull = date => format(date, 'dddd, Do MMMM YYYY');
289289
```
290290

291-
##### formatMonth
291+
#### formatMonth
292292

293293
A function to format a human-readable month, for example: "January 2017":
294294

@@ -300,6 +300,6 @@ import format from 'date-fns/format';
300300
const formatMonth = date => format(date, 'MMMM YYYY');
301301
```
302302

303-
##### weekStartsOn
303+
#### weekStartsOn
304304

305305
First day of the week. 0 = Sunday, 1 = Monday, ..., 6 = Saturday.

packages/bpk-component-card/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export default () => (
2323
);
2424
```
2525

26-
### Props
26+
## Props
2727

2828
| Property | PropType | Required | Default Value |
2929
| --------- | -------- | -------- | ------------- |

packages/bpk-component-checkbox/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export default () => (
2424
);
2525
```
2626

27-
### Props
27+
## Props
2828

2929
| Property | PropType | Required | Default Value |
3030
| --------- | -------- | -------- | ------------- |

packages/bpk-component-close-button/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default () => (
1919
);
2020
```
2121

22-
### Props
22+
## Props
2323

2424
| Property | PropType | Required | Default Value |
2525
| -------- | -------- | -------- | ------------- |

packages/bpk-component-code/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export default () => (
3131
);
3232
```
3333

34-
### Props
34+
## Props
3535

3636
*For BpkCode & BpkCodeBlock:*
3737

packages/bpk-component-content-container/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export default () => (
2222
);
2323
```
2424

25-
### Props
25+
## Props
2626

2727
| Property | PropType | Required | Default Value |
2828
| ----------------------- | -------------------------------------------- | -------- | ------------- |

packages/bpk-component-datepicker/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class App extends Component {
6565
}
6666
```
6767

68-
### Props
68+
## Props
6969

7070
For more information on some these props, check the BpkCalendar documentation.
7171

packages/bpk-component-fieldset/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ class FieldsetContainer extends Component {
5454
}
5555
```
5656

57-
### Props
57+
## Props
5858

5959
| Property | PropType | Required | Default Value |
6060
| ----------------- | -------- | -------- | ------------- |

packages/bpk-component-form-validation/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export default () => (
2121
)
2222
```
2323

24-
### Props
24+
## Props
2525

2626
| Property | PropType | Required | Default Value |
2727
| -------------- | -------- | -------- | ------------- |

packages/bpk-component-grid-toggle/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default () => (
1919
);
2020
```
2121

22-
### Props
22+
## Props
2323

2424
| Property | PropType | Required | Default Value |
2525
| ---------------- | -------- | -------- | ------------- |

packages/bpk-component-grid/readme.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -58,24 +58,24 @@ export default () => (
5858
);
5959
```
6060

61-
### Props
61+
## Props
6262

63-
*BpkGridContainer:*
63+
### BpkGridContainer
6464

6565
| Property | PropType | Required | Default Value |
6666
| --------- | -------- | -------- | ------------- |
6767
| children | node | true | - |
6868
| debug | bool | false | false |
6969
| fullWidth | bool | false | false |
7070

71-
*BpkGridRow:*
71+
### BpkGridRow
7272

7373
| Property | PropType | Required | Default Value |
7474
| --------- | -------- | -------- | ------------- |
7575
| children | node | true | - |
7676
| padded | bool | false | true |
7777

78-
*BpkGridColumn:*
78+
### BpkGridColumn
7979

8080
| Property | PropType | Required | Default Value |
8181
| ------------ | -------- | -------- | ------------- |

packages/bpk-component-heading/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default () => (
1919
);
2020
```
2121

22-
### Props
22+
## Props
2323

2424
| Property | PropType | Required | Default Value |
2525
| ------------ | ---------------------------------- | -------- | ------------- |

packages/bpk-component-horizontal-nav/readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@ export default () => (
2323
)
2424
```
2525

26-
### Props
26+
## Props
2727

28-
*BpkHorizontalNav:*
28+
### BpkHorizontalNav
2929

3030
| Property | PropType | Required | Default Value |
3131
| ----------- | -------- | -------- | ------------- |
3232
| children | node | true | - |
3333
| className | string | false | null |
3434
| spaceAround | bool | false | false |
3535

36-
*BpkHorizontalNavItem:*
36+
### BpkHorizontalNavItem
3737

3838
| Property | PropType | Required | Default Value |
3939
| --------- | -------- | -------- | ------------- |

packages/bpk-component-icon/readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export default () => (
3838
}
3939
```
4040

41-
## Aligning to BpkButton components
41+
### Aligning to BpkButton components
4242

4343
```js
4444
import React from 'react';
@@ -64,7 +64,7 @@ export default () => (
6464
);
6565
```
6666

67-
## RTL support
67+
### RTL support
6868

6969
```js
7070
import React from 'react';

packages/bpk-component-input/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export default () => (
2626
);
2727
```
2828

29-
### Props
29+
## Props
3030

3131
| Property | PropType | Required | Default Value |
3232
| ------------ | -------------------- | --------- | ---------------- |

packages/bpk-component-label/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default () => (
1919
)
2020
```
2121

22-
### Props
22+
## Props
2323

2424
| Property | PropType | Required | Default Value |
2525
| --------- | -------- | -------- | ------------- |

packages/bpk-component-link/readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ export default () => (
2222
)
2323
```
2424

25-
### Props
25+
## Props
2626

27-
*BpkLink:*
27+
### BpkLink
2828

2929
| Property | PropType | Required | Default Value |
3030
| -------- | -------- | -------- | ------------- |
@@ -34,7 +34,7 @@ export default () => (
3434
| blank | bool | false | false |
3535
| white | bool | false | false |
3636

37-
*BpkLinkButton:*
37+
### BpkLinkButton
3838

3939
| Property | PropType | Required | Default Value |
4040
| -------- | -------- | -------- | ------------- |

packages/bpk-component-list/readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ export default () => (
3030
);
3131
```
3232

33-
### Props
33+
## Props
3434

35-
*BpkList:*
35+
### BpkList
3636

3737
| Property | PropType | Required | Default Value |
3838
| -------- | -------- | -------- | ------------- |
3939
| children | - | true | - |
4040
| ordered | bool | false | false |
4141

42-
*BpkListItem:*
42+
### BpkListItem
4343

4444
| Property | PropType | Required | Default Value |
4545
| -------- | -------- | -------- | ------------- |

packages/bpk-component-loading-button/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export default () => (
3333
);
3434
```
3535

36-
### Props
36+
## Props
3737

3838
| Property | PropType | Required | Default Value |
3939
| ------------ | -------- | -------- | ------------- |

0 commit comments

Comments
 (0)