Skip to content

Commit f158c5d

Browse files
daundaun
committed
Format markdown tables in docs
1 parent fc0b199 commit f158c5d

File tree

12 files changed

+67
-67
lines changed

12 files changed

+67
-67
lines changed

‎docs/panels.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ The module comes bundled with a set of pre-defined panel types.
44

55
Click the images below for details about each panel type.
66

7-
|Image|Panel|Description|
8-
|---|---|---|
9-
|[![Chart](./images/chart.png ':size=120')](/panels/chart.md)|`chart`|Chart.js chart|
10-
|[![Collection](./images/collection.png ':size=120')](/panels/collection.md)|`collection`|List of pages in a table|
11-
|[![Notice](./images/notice.png ':size=120')](/panels/notice.md)|`notice`|Notification-style message|
12-
|[![Number](./images/number.png ':size=120')](/panels/number.md)|`number`|Large number with trend indicator|
13-
|[![PageList](./images/page-list.png ':size=120')](/panels/page-list.md)|`page-list`|ProcessPageList widget|
14-
|[![Shortcuts](./images/shortcuts-grid.png ':size=120')](/panels/shortcuts.md)|`shortcuts`|List of links with icons|
15-
|[![Template](./images/template.png ':size=120')](/panels/template.md)|`template`|Render file in template folder|
16-
|[![Add New Page](./images/add-new.png ':size=120')](/panels/add-new.md)|`add-new`|Add new page|
7+
| Image | Panel | Description |
8+
| ----------------------------------------------------------------------------- | ------------ | --------------------------------- |
9+
| [![Chart](./images/chart.png ':size=120')](/panels/chart.md) | `chart` | Chart.js chart |
10+
| [![Collection](./images/collection.png ':size=120')](/panels/collection.md) | `collection` | List of pages in a table |
11+
| [![Notice](./images/notice.png ':size=120')](/panels/notice.md) | `notice` | Notification-style message |
12+
| [![Number](./images/number.png ':size=120')](/panels/number.md) | `number` | Large number with trend indicator |
13+
| [![PageList](./images/page-list.png ':size=120')](/panels/page-list.md) | `page-list` | ProcessPageList widget |
14+
| [![Shortcuts](./images/shortcuts-grid.png ':size=120')](/panels/shortcuts.md) | `shortcuts` | List of links with icons |
15+
| [![Template](./images/template.png ':size=120')](/panels/template.md) | `template` | Render file in template folder |
16+
| [![Add New Page](./images/add-new.png ':size=120')](/panels/add-new.md) | `add-new` | Add new page |

‎docs/panels/add-new.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ The list of templates is derived from ProcessWire's core Add-New-Page dropdown.
1111

1212
Required parameters are marked with an asterisk `*`
1313

14-
|Parameter|Type|Default|Description|
15-
|---|---|---|---|
16-
|`display`|`string`|`list`|How to display the links: `list` or `dropdown`|
14+
| Parameter | Type | Default | Description |
15+
| --------- | -------- | ------- | ---------------------------------------------- |
16+
| `display` | `string` | `list` | How to display the links: `list` or `dropdown` |
1717

1818
## Example
1919

‎docs/panels/chart.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Display a chart using [Chart.js](https://www.chartjs.org/).
88

99
Required parameters are marked with an asterisk `*`
1010

11-
|Parameter|Type|Default|Description|
12-
|---|---|---|---|
13-
|**`chart *`**|`array`|`[]`|Chart.js configuration options|
11+
| Parameter | Type | Default | Description |
12+
| ------------- | ------- | ------- | ------------------------------ |
13+
| **`chart *`** | `array` | `[]` | Chart.js configuration options |
1414

1515
## Example
1616

‎docs/panels/collection.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ Display a collection of pages in a table. Supply either a PageArray or a selecto
88

99
Required parameters are marked with an asterisk `*`
1010

11-
|Parameter|Type|Default|Description|
12-
|---|---|---|---|
13-
|**`collection *`**|`PageArray`, `string`||Collection of pages to show (or selector string)|
14-
|`columns`|`array`|`title`, `url`|Columns to display|
15-
|`sortable`|`bool`|`false`|Make table columns sortable?|
16-
|`actions`|`array`, `bool`|`view`, `edit`|Actions to allow: `view`, `edit`, `trash` (`false` to disable)|
17-
|`editMode`|`string`|`blank`|How to open edit links (`none` for same window, `blank` for new tab or `modal`)|
18-
|`viewMode`|`string`|`blank`|How to open view links (same options as `editMode`)|
19-
|`pagination`|`bool`|`true`|Display pagination links if collection has a `limit` set?|
20-
|`headers`|`bool`|`true`|Display table headers?|
21-
|`emptyMessage`|`string`|—|Placeholder to show if the collection is empty, i.e. no pages were found|
22-
|`dateFormat`|`string`|`relative`|Format to use for DateTime columns|
23-
|`maxImageNum`|`int`|`1`|Number of thumbnails to show for image columns|
11+
| Parameter | Type | Default | Description |
12+
| ------------------ | --------------------- | -------------- | ------------------------------------------------------------------------------- |
13+
| **`collection *`** | `PageArray`, `string` | | Collection of pages to show (or selector string) |
14+
| `columns` | `array` | `title`, `url` | Columns to display |
15+
| `sortable` | `bool` | `false` | Make table columns sortable? |
16+
| `actions` | `array`, `bool` | `view`, `edit` | Actions to allow: `view`, `edit`, `trash` (`false` to disable) |
17+
| `editMode` | `string` | `blank` | How to open edit links (`none` for same window, `blank` for new tab or `modal`) |
18+
| `viewMode` | `string` | `blank` | How to open view links (same options as `editMode`) |
19+
| `pagination` | `bool` | `true` | Display pagination links if collection has a `limit` set? |
20+
| `headers` | `bool` | `true` | Display table headers? |
21+
| `emptyMessage` | `string` | — | Placeholder to show if the collection is empty, i.e. no pages were found |
22+
| `dateFormat` | `string` | `relative` | Format to use for DateTime columns |
23+
| `maxImageNum` | `int` | `1` | Number of thumbnails to show for image columns |
2424

2525
## Example
2626

‎docs/panels/groups.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ foreach (getNotifications() as $message) {
2525

2626
## Options
2727

28-
|Parameter|Type|Default|Description|
29-
|---|---|---|---|
30-
|`title`|`string`||Heading displayed above the group|
31-
|`margin`|`bool`|`false`|Add extra margin below the group|
32-
|`align`|`string`|`fill`|Control vertical alignment of the panels inside the group: `top`, `bottom`, `center`, `distribute` (add space between) or `fill` (stretch to fill space)|
28+
| Parameter | Type | Default | Description |
29+
| --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
30+
| `title` | `string` | | Heading displayed above the group |
31+
| `margin` | `bool` | `false` | Add extra margin below the group |
32+
| `align` | `string` | `fill` | Control vertical alignment of the panels inside the group: `top`, `bottom`, `center`, `distribute` (add space between) or `fill` (stretch to fill space) |
3333

3434
## Example configuration
3535

‎docs/panels/notice.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ Display a notice with icon and actions. If set, the panel's title will be displa
88

99
Required parameters are marked with an asterisk `*`
1010

11-
|Parameter|Type|Default|Description|
12-
|---|---|---|---|
13-
|**`message *`**|`string`||Notice to display|
14-
|`status`|`string`|`notice`|Status of the notice: `notice`, `success`, `warning` or `error`|
15-
|`actions`|`array`|`[]`|Additional links to display (array of format `['Label' => 'url']`)|
11+
| Parameter | Type | Default | Description |
12+
| --------------- | -------- | -------- | ------------------------------------------------------------------ |
13+
| **`message *`** | `string` | | Notice to display |
14+
| `status` | `string` | `notice` | Status of the notice: `notice`, `success`, `warning` or `error` |
15+
| `actions` | `array` | `[]` | Additional links to display (array of format `['Label' => 'url']`) |
1616

1717
## Example
1818

‎docs/panels/number.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ Display a large number with trend indicator.
88

99
Required parameters are marked with an asterisk `*`
1010

11-
|Parameter|Type|Default|Description|
12-
|---|---|---|---|
13-
|**`number *`**|`int`, `float`, `string`||The number to display|
14-
|`detail`|`string`||Additional information to display below|
15-
|`trend`|`string`||Trend to indicate with green/red arrows: `up` or `down`|
16-
|`locale`|`string`|server locale|Locale to use for formatting integers or floats|
11+
| Parameter | Type | Default | Description |
12+
| -------------- | ------------------------ | ------------- | ------------------------------------------------------- |
13+
| **`number *`** | `int`, `float`, `string` | | The number to display |
14+
| `detail` | `string` | | Additional information to display below |
15+
| `trend` | `string` | | Trend to indicate with green/red arrows: `up` or `down` |
16+
| `locale` | `string` | server locale | Locale to use for formatting integers or floats |
1717

1818
## Example
1919

‎docs/panels/page-list.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Display a ProcessPageList widget.
66

77
## Options
88

9-
|Parameter|Type|Default|Description|
10-
|---|---|---|---|
11-
|`parent`|`Page`, `int`, `string`|Homepage|Root page to render the page list for (Page, ID or selector)|
12-
|`showRootPage`|`bool`|`true`|Include the root page in the output?|
13-
|`editMode`|`string`|`blank`|How to open edit links (`none` for same window, `blank` for new tab or `modal`)|
14-
|`viewMode`|`string`|`blank`|How to open view links (same options as `editMode`)|
9+
| Parameter | Type | Default | Description |
10+
| -------------- | ----------------------- | -------- | ------------------------------------------------------------------------------- |
11+
| `parent` | `Page`, `int`, `string` | Homepage | Root page to render the page list for (Page, ID or selector) |
12+
| `showRootPage` | `bool` | `true` | Include the root page in the output? |
13+
| `editMode` | `string` | `blank` | How to open edit links (`none` for same window, `blank` for new tab or `modal`) |
14+
| `viewMode` | `string` | `blank` | How to open view links (same options as `editMode`) |
1515

1616
## Example
1717

‎docs/panels/shortcuts.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Display a list of shortcuts as links with icons. In list view, the page summary
99

1010
Required parameters are marked with an asterisk `*`
1111

12-
|Parameter|Type|Default|Description|
13-
|---|---|---|---|
14-
|**`shortcuts *`**|`array`||Shortcuts to display: Page objects, page IDs, selectors and URLs|
15-
|`display`|`string`|`grid`|How to display the shortcuts: `grid` or `list`|
16-
|`summaries`|`bool`|`true`|Whether to display summaries|
17-
|`fallbackIcon`|`string`|`bookmark-o`|Icon to use if page doesn't have one|
18-
|`icon`|`string`|none|Icon to uniformly use for **all** pages|
19-
|`checkAccess`|`bool`|`true`|Only show pages the user has access to|
12+
| Parameter | Type | Default | Description |
13+
| ----------------- | -------- | ------------ | ---------------------------------------------------------------- |
14+
| **`shortcuts *`** | `array` | | Shortcuts to display: Page objects, page IDs, selectors and URLs |
15+
| `display` | `string` | `grid` | How to display the shortcuts: `grid` or `list` |
16+
| `summaries` | `bool` | `true` | Whether to display summaries |
17+
| `fallbackIcon` | `string` | `bookmark-o` | Icon to use if page doesn't have one |
18+
| `icon` | `string` | none | Icon to uniformly use for **all** pages |
19+
| `checkAccess` | `bool` | `true` | Only show pages the user has access to |
2020

2121
See the example below on how to customize the icon, title, summary and URL for each shortcut.
2222

‎docs/panels/tabs.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ $panels->add($tab);
1919

2020
Required parameters are marked with an asterisk `*`
2121

22-
|Parameter|Type|Default|Description|
23-
|---|---|---|---|
24-
|**`title *`**|`string`||Clickable tab label|
22+
| Parameter | Type | Default | Description |
23+
| ------------- | -------- | ------- | ------------------- |
24+
| **`title *`** | `string` | | Clickable tab label |

0 commit comments

Comments
 (0)