Skip to content

Commit 2e12e24

Browse files
committed
default fixup
1 parent 3011261 commit 2e12e24

33 files changed

+138
-100
lines changed

.github/workflows/ci.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,12 @@ jobs:
2424
with:
2525
fetch-depth: 0
2626

27-
- name: Lint
28-
uses: super-linter/super-linter/slim@v7
29-
env:
30-
VALIDATE_EDITORCONFIG: false
31-
VALIDATE_JSCPD: false
32-
VALIDATE_MARKDOWN_PRETTIER: false
33-
DEFAULT_BRANCH: "origin/4.2"
34-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27+
- uses: articulate/actions-markdownlint@v1
28+
with:
29+
config: .markdownlint.yaml
30+
files: '**/*.md'
31+
ignore: node_modules
32+
version: 0.46.1
3533

3634
- uses: actions/cache@v4
3735
with:

.markdownlint.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
MD013:
3+
line_length: 400
4+
no-inline-html:
5+
allowed_elements: [a, p, img, br, code-selector]
6+
MD046:
7+
style: fenced
8+
MD004:
9+
style: dash

.markdownlint.yml

Lines changed: 0 additions & 5 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,17 @@ By contributing to this project, you agree to abide by our [Code of Conduct](htt
2424
1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page.
2525

2626
2. Clone the forked repository to your local machine:
27+
2728
```console
2829
git clone https://github.com/your-username/repository-name.git
2930
```
31+
3032
3. Create a new branch for your contribution:
33+
3134
```console
3235
git switch -c docs-your-branch-name
3336
```
37+
3438
4. Commit and push your changes
3539
5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the nature of the change.
3640
See [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,3 @@ This repository contains all the API Platform documentation resources.
1111
## Contributing
1212

1313
Please check our [CONTRIBUTING file](/CONTRIBUTING.md) to contribute.
14-

admin/components.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,6 @@ export const BooksShow = () => (
379379

380380
`<ShowGuesser>` accepts all props accepted by both React Admin [`<Show>` component](https://marmelab.com/react-admin/Show.html) and [`<SimpleShowLayout>` component](https://marmelab.com/react-admin/SimpleShowLayout.html).
381381

382-
383382
## FieldGuesser
384383

385384
Renders a field according to its type, using the [schema analyzer](./components.md#hydra-schema-analyzer).
@@ -445,4 +444,3 @@ You can also pass props that are specific to a certain input component. For exam
445444
```tsx
446445
<InputGuesser source="description" multiline />
447446
```
448-

admin/customizing.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,6 @@ Let's customize this `ReviewEdit` component to:
277277
- make the `body` input multiline
278278
- mark the `publicationDate` input as read-only
279279

280-
281280
```diff
282281
export const ReviewEdit = () => (
283282
<EditGuesser>

admin/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,4 +125,4 @@ bin/console cache:clear --env=prod
125125

126126
## Next Step
127127

128-
Learn how to add more features to your generated Admin by [Customizing the Schema](./schema.md).
128+
Learn how to add more features to your generated Admin by [Customizing the Schema](./schema.md).

admin/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ By [leveraging React Admin components](./advanced-customization.md), you can fur
5656

5757
## Next Step
5858

59-
Get your Admin up and running by following the [Getting Started guide](./getting-started.md).
59+
Get your Admin up and running by following the [Getting Started guide](./getting-started.md).

admin/validation.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,15 @@ export const BookEdit = () => (
8282

8383
React Admin already comes with several [built-in validators](https://marmelab.com/react-admin/Validation.html#per-input-validation-built-in-field-validators), such as:
8484

85-
* `required(message)` if the field is mandatory,
86-
* `minValue(min, message)` to specify a minimum value for integers,
87-
* `maxValue(max, message)` to specify a maximum value for integers,
88-
* `minLength(min, message)` to specify a minimum length for strings,
89-
* `maxLength(max, message)` to specify a maximum length for strings,
90-
* `number(message)` to check that the input is a valid number,
91-
* `email(message)` to check that the input is a valid email address,
92-
* `regex(pattern, message)` to validate that the input matches a regular expression,
93-
* `choices(list, message)` to validate that the input is within a given list
85+
- `required(message)` if the field is mandatory,
86+
- `minValue(min, message)` to specify a minimum value for integers,
87+
- `maxValue(max, message)` to specify a maximum value for integers,
88+
- `minLength(min, message)` to specify a minimum length for strings,
89+
- `maxLength(max, message)` to specify a maximum length for strings,
90+
- `number(message)` to check that the input is a valid number,
91+
- `email(message)` to check that the input is a valid email address,
92+
- `regex(pattern, message)` to validate that the input matches a regular expression,
93+
- `choices(list, message)` to validate that the input is within a given list
9494

9595
React Admin also supports [Global Validation](https://marmelab.com/react-admin/Validation.html#global-validation) (at the form level).
9696

0 commit comments

Comments
 (0)