Skip to content

Added markdownlint2 for detecting Markdown formatting issues #3102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mnocon wants to merge 2 commits into
base: 5.0
Choose a base branch
from
+75 −27
Open

Added markdownlint2 for detecting Markdown formatting issues #3102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
420cfdd
Added markdownlint2 for detecting Markdown formatting issues
mnocon Mar 20, 2026
928c29b
Revert "Fixed table formatting (#3100)"
mnocon Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,18 @@ jobs:
exit 1
fi

markdownlint:
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'

steps:
- uses: actions/checkout@v4

- name: Run markdownlint
uses: DavidAnson/markdownlint-cli2-action@v20
with:
globs: "docs/**/*.md"

vale-check:
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
Expand Down
19 changes: 19 additions & 0 deletions .markdownlint-cli2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
config:
default: false
heading-style: consistent
list-indent: true
no-reversed-links: true
no-missing-space-atx: true
heading-start-left: true
no-multiple-space-blockquote: true
no-blanks-blockquote: true
hr-style: true
no-empty-links: true
code-fence-style: backtick
strong-style: asterisk
table-pipe-style:
style: leading_and_trailing

ignores:
- "docs/snippets/**"
- "docs/index.md"
37 changes: 25 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,9 @@

### Contribute to API reference

The REST API Reference is located in the `docs/api/rest_api/rest_api_reference/rest_api_reference.html`
file, which is generated automatically by the RAML2HTML tool.
It is based on `*.raml` files located in the `docs/api/rest_api/rest_api_reference/input` directory that you can edit in your editor/IDE.

After you modify relevant files in the input folder, you can generate an HTML file from repository root (this step can also be performed by one of the Tech Writers during PR review):

`php tools/raml2html/raml2html.php build --non-standard-http-methods=COPY,MOVE,PUBLISH,SWAP -t default -o docs/api/rest_api/rest_api_reference/output/ docs/api/rest_api/rest_api_reference/input/ibexa.raml`

In case of errors, look for mistakes in the RAML file, for example, double apostrophes.
Move `rest_api_reference.html` from the output folder to `docs/api/rest_api/rest_api_reference/` root.

See `tools/raml2html/README.md` for more information.
The REST API Reference is located in the `docs/api/rest_api/rest_api_reference/` directory.
It is based on an OpenAPI specification (`openapi.yaml` / `openapi.json`) generated from the Ibexa DXP source code.
To contribute to the REST API reference, you must modify the source code annotations directly.

Check notice on line 25 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L25 

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output 
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "README.md", "range": {"start": {"line": 25, "column": 4}}}, "severity": "INFO"}

## Build and preview documentation

Expand All @@ -53,6 +44,28 @@

## Testing the code samples

### markdownlint

Check failure on line 48 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L48 

[Ibexa.CodeBlockLanguages] Always provide a language with a code block.
Raw output 
{"message": "[Ibexa.CodeBlockLanguages] Always provide a language with a code block.", "location": {"path": "README.md", "range": {"start": {"line": 48, "column": 1}}}, "severity": "ERROR"}
This repository uses [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) to check Markdown formatting, including table syntax.

Install dependencies:

Check notice on line 52 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L52 

[Ibexa.ByUsingStartOfLine] Prefer 'by using' or 'with' to plain 'using'.
Raw output 
{"message": "[Ibexa.ByUsingStartOfLine] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "README.md", "range": {"start": {"line": 52, "column": 5}}}, "severity": "INFO"}

Check notice on line 52 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L52 

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output 
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "README.md", "range": {"start": {"line": 52, "column": 5}}}, "severity": "INFO"}
```bash
yarn install

Check failure on line 54 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L54 

[Ibexa.Spellcheck] Did you really mean 'VSCode'?
Raw output 
{"message": "[Ibexa.Spellcheck] Did you really mean 'VSCode'?", "location": {"path": "README.md", "range": {"start": {"line": 54, "column": 28}}}, "severity": "ERROR"}
Copy link
Contributor Author

@mnocon mnocon Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

I have no idea what Vale means here - maybe #3099 would help?

```

Run the linter:

Check failure on line 57 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L57 

[Ibexa.Spellcheck] Did you really mean 'VSCode'?
Raw output 
{"message": "[Ibexa.Spellcheck] Did you really mean 'VSCode'?", "location": {"path": "README.md", "range": {"start": {"line": 57, "column": 12}}}, "severity": "ERROR"}

```bash

Check notice on line 59 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L59 

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output 
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "README.md", "range": {"start": {"line": 59, "column": 5}}}, "severity": "INFO"}

Check notice on line 59 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L59 

[Ibexa.ByUsingStartOfLine] Prefer 'by using' or 'with' to plain 'using'.
Raw output 
{"message": "[Ibexa.ByUsingStartOfLine] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "README.md", "range": {"start": {"line": 59, "column": 5}}}, "severity": "INFO"}
yarn markdownlint
```

Some issues can be fixed automatically:

```bash
yarn markdownlint --fix

Check notice on line 66 in README.md

View workflow job for this annotation

GitHub Actions / vale

[vale] README.md#L66 

[Ibexa.ByUsingStartOfLine] Prefer 'by using' or 'with' to plain 'using'.
Raw output 
{"message": "[Ibexa.ByUsingStartOfLine] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "README.md", "range": {"start": {"line": 66, "column": 4}}}, "severity": "INFO"}
```

### PHPStan

This repository uses PHPStan to test the code samples. To run the tests locally execute the commands below:
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/back_office/back_office_menus/back_office_menus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can listen to the following events:
|| `ConfigureMenuEvent::CONTENT_CREATE_SIDEBAR_RIGHT` |
|| `ConfigureMenuEvent::CONTENT_SIDEBAR_LEFT` |
| Trash | `ConfigureMenuEvent::TRASH_SIDEBAR_RIGHT` |
| Section | `ConfigureMenuEvent::SECTION_EDIT_SIDEBAR_RIGHT`
| Section | `ConfigureMenuEvent::SECTION_EDIT_SIDEBAR_RIGHT` |
|| `ConfigureMenuEvent::SECTION_CREATE_SIDEBAR_RIGHT` |
| Policies and permissions | `ConfigureMenuEvent::POLICY_EDIT_SIDEBAR_RIGHT` |
|| `ConfigureMenuEvent::POLICY_CREATE_SIDEBAR_RIGHT` |
Expand Down
4 changes: 2 additions & 2 deletions docs/administration/project_organization/bundles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ To remove a bundle (either one you created yourself, or an out-of-the-box one th
|ibexa/experience|Metapackage for Symfony Flex-based [[= product_name =]] Experience installation|
|ibexa/cart|Main store functionalities|
|ibexa/checkout|Store checkout functionality|
|ibexa/corporate-account-commerce-bridge|Additional functionality for [corporate accounts](corporate_admin_panel.md|
|ibexa/discounts|Adds [discounts](discounts.md) functionality|feature
|ibexa/corporate-account-commerce-bridge|Additional functionality for [corporate accounts](corporate_admin_panel.md)|
|ibexa/discounts|Adds [discounts](discounts.md) functionality|
|ibexa/discounts-codes|Adds the possibility to use discount codes with the [Discounts](discounts.md) functionality|
|ibexa/storefront|A storefront starting kit|
|ibexa/order-management|Order management|
Expand Down
4 changes: 2 additions & 2 deletions docs/api/event_reference/twig_component_events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@

| Event | Dispatched by | Description |
|---|---|---|
|`RenderGroupEvent`| `\Ibexa\TwigComponents\Component\Renderer\DefaultRenderer::renderGroup()` | Dispatched before a Component group is rendered
|`RenderSingleEvent`| `\Ibexa\TwigComponents\Component\Renderer\DefaultRenderer::renderSingle()` |Dispatched before a single Component is rendered
|`RenderGroupEvent`| `\Ibexa\TwigComponents\Component\Renderer\DefaultRenderer::renderGroup()` | Dispatched before a Component group is rendered |

Check notice on line 15 in docs/api/event_reference/twig_component_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/twig_component_events.md#L15 

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output 
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/api/event_reference/twig_component_events.md", "range": {"start": {"line": 15, "column": 134}}}, "severity": "INFO"}
|`RenderSingleEvent`| `\Ibexa\TwigComponents\Component\Renderer\DefaultRenderer::renderSingle()` |Dispatched before a single Component is rendered |

Check notice on line 16 in docs/api/event_reference/twig_component_events.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/event_reference/twig_component_events.md#L16 

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output 
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/api/event_reference/twig_component_events.md", "range": {"start": {"line": 16, "column": 136}}}, "severity": "INFO"}
2 changes: 1 addition & 1 deletion docs/permissions/policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ The [discount](discounts.md) policies decide which actions can be executed by gi

| Module | Function | Effect | Possible limitations |
|----------------------|-----------------------|--------------------------------------------------------------------------|----------------------|
| <nobr>`content`</nobr> | <nobr>`share`</nobr> | share content drafts with internal and external users through [collaborative editing](collaborative_editing.md) |[Owner](limitation_reference.md#collaborative-editing-owner-limitation)</br>[PublicLink](limitation_reference.md#collaborative-editing-publiclink-limitation)</br>[Scope](limitation_reference.md#collaborative-editing-scope-limitation)
| <nobr>`content`</nobr> | <nobr>`share`</nobr> | share content drafts with internal and external users through [collaborative editing](collaborative_editing.md) |[Owner](limitation_reference.md#collaborative-editing-owner-limitation)</br>[PublicLink](limitation_reference.md#collaborative-editing-publiclink-limitation)</br>[Scope](limitation_reference.md#collaborative-editing-scope-limitation) |
| <nobr>`rte`</nobr> | <nobr>`edit`</nobr> | use [Real-time editing](collaborative_editing_guide.md#real-time-editing) |


Expand Down
2 changes: 1 addition & 1 deletion docs/personalization/api_reference/recommendation_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ For more information, see [Submodels]([[= user_doc =]]/personalization/recommend

If you have configured segments, you can use them in the recommendation model. Pass the following parameter to request recommendations for a specific segment or segment group.

Parameter|Example|Description|Value|
|Parameter|Example|Description|Value|
|---|---|---|---|
|`segments`|`&segments=7,8,10,11`|ID from segment group management|string|

Expand Down
4 changes: 2 additions & 2 deletions docs/release_notes/ez_platform_v3.0_deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ The following event names have been changed:
|`openUdw`|`ez-open-udw`|
|`updateFieldName`|`ez-update-field-name`|
|`fbFormBuilderLoaded`|`ez-form-builder-loaded`|
|`fbFormBuilderUnloaded`|`ez-form-builder-unloaded`
|`fbFormBuilderUnloaded`|`ez-form-builder-unloaded`|

## ezplatform-http-cache

Expand Down Expand Up @@ -820,7 +820,7 @@ The following namespaces have been changed:
|Namespace|Former location|New location|
|---------|------------|---------------|
|`FieldData`|`EzSystems\RepositoryForms\Data\Content\`|`EzSystems\EzPlatformContentForms\Data\Content\`|
|`FieldValueFormMapperInterface`|`EzSystems\RepositoryForms\FieldType\`|`EzSystems\EzPlatformContentForms\FieldType\`
|`FieldValueFormMapperInterface`|`EzSystems\RepositoryForms\FieldType\`|`EzSystems\EzPlatformContentForms\FieldType\`|

## ezplatform-rest

Expand Down
2 changes: 1 addition & 1 deletion docs/release_notes/ibexa_dxp_v3.2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,4 @@

| Ibexa Platform | [[= product_name =]] | [[= product_name_com =]] |
|--------------|------------|------------|
| [Ibexa Platform v3.2.0](https://github.com/ezsystems/ezplatform/releases/tag/v3.2.0) | [[[= product_name =]] v3.2.0](https://github.com/ezsystems/ezplatform-ee/releases/tag/v3.2.0) | [[[= product_name_com =]] v3.2.0](https://github.com/ezsystems/ezcommerce/releases/tag/v3.2.0)
| [Ibexa Platform v3.2.0](https://github.com/ezsystems/ezplatform/releases/tag/v3.2.0) | [[[= product_name =]] v3.2.0](https://github.com/ezsystems/ezplatform-ee/releases/tag/v3.2.0) | [[[= product_name_com =]] v3.2.0](https://github.com/ezsystems/ezcommerce/releases/tag/v3.2.0) |

Check failure on line 115 in docs/release_notes/ibexa_dxp_v3.2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release_notes/ibexa_dxp_v3.2.md#L115 

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output 
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/release_notes/ibexa_dxp_v3.2.md", "range": {"start": {"line": 115, "column": 4}}}, "severity": "ERROR"}

Check failure on line 115 in docs/release_notes/ibexa_dxp_v3.2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release_notes/ibexa_dxp_v3.2.md#L115 

[Ibexa.VariablesVersion] Use global variable '[[= latest_tag_3_3 =]]' instead of 'v3.2.0'
Raw output 
{"message": "[Ibexa.VariablesVersion] Use global variable '[[= latest_tag_3_3 =]]' instead of 'v3.2.0'", "location": {"path": "docs/release_notes/ibexa_dxp_v3.2.md", "range": {"start": {"line": 115, "column": 19}}}, "severity": "ERROR"}

Check failure on line 115 in docs/release_notes/ibexa_dxp_v3.2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release_notes/ibexa_dxp_v3.2.md#L115 

[Ibexa.VariablesVersion] Use global variable '[[= latest_tag_3_3 =]]' instead of 'v3.2.0'
Raw output 
{"message": "[Ibexa.VariablesVersion] Use global variable '[[= latest_tag_3_3 =]]' instead of 'v3.2.0'", "location": {"path": "docs/release_notes/ibexa_dxp_v3.2.md", "range": {"start": {"line": 115, "column": 112}}}, "severity": "ERROR"}

Check failure on line 115 in docs/release_notes/ibexa_dxp_v3.2.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release_notes/ibexa_dxp_v3.2.md#L115 

[Ibexa.VariablesVersion] Use global variable '[[= latest_tag_3_3 =]]' instead of 'v3.2.0'
Raw output 
{"message": "[Ibexa.VariablesVersion] Use global variable '[[= latest_tag_3_3 =]]' instead of 'v3.2.0'", "location": {"path": "docs/release_notes/ibexa_dxp_v3.2.md", "range": {"start": {"line": 115, "column": 212}}}, "severity": "ERROR"}
2 changes: 1 addition & 1 deletion docs/release_notes/ibexa_dxp_v4.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,4 +119,4 @@ for full details of changes and how they influence your project.

| [[= product_name_content =]] | [[= product_name_exp =]] | [[= product_name_com =]] |
|--------------|------------|------------|
| [[[= product_name_content =]] v4.0](https://github.com/ibexa/content/releases/tag/v4.0.0) | [[[= product_name_exp =]] v4.0](https://github.com/ibexa/experience/releases/tag/v4.0.0) | [[[= product_name_com =]] v4.0](https://github.com/ibexa/commerce/releases/tag/v4.0.0)
| [[[= product_name_content =]] v4.0](https://github.com/ibexa/content/releases/tag/v4.0.0) | [[[= product_name_exp =]] v4.0](https://github.com/ibexa/experience/releases/tag/v4.0.0) | [[[= product_name_com =]] v4.0](https://github.com/ibexa/commerce/releases/tag/v4.0.0) |
2 changes: 1 addition & 1 deletion docs/release_notes/ibexa_dxp_v4.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@ which prevents multiple processes from executing the same migration and causing

| [[= product_name_content =]] | [[= product_name_exp =]] | [[= product_name_com =]] |
|--------------|------------|------------|
| [[[= product_name_content =]] v4.1](https://github.com/ibexa/content/releases/tag/v4.1.0) | [[[= product_name_exp =]] v4.1](https://github.com/ibexa/experience/releases/tag/v4.1.0) | [[[= product_name_com =]] v4.1](https://github.com/ibexa/commerce/releases/tag/v4.1.0)
| [[[= product_name_content =]] v4.1](https://github.com/ibexa/content/releases/tag/v4.1.0) | [[[= product_name_exp =]] v4.1](https://github.com/ibexa/experience/releases/tag/v4.1.0) | [[[= product_name_com =]] v4.1](https://github.com/ibexa/commerce/releases/tag/v4.1.0) |
4 changes: 3 additions & 1 deletion docs/search/collaboration_search_reference/collaboration_criteria.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@
| [Id](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-Id.html) | Find invitations with given invitation ID |
| [LogicalAnd](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-LogicalAnd.html) | Composite criterion to group multiple criteria using the AND condition |
| [LogicalOr](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-LogicalOr.html) | Composite criterion to group multiple criteria using the OR condition |
| [ParticipantScope](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-ParticipantScope.html) | Find invitations based on participant's scope, see [`ContentSessionScope`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Share-Collaboration-ContentSessionScope.html) for content-sharing sessions |
| [ParticipantScope](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-ParticipantScope.html)

Check failure on line 21 in docs/search/collaboration_search_reference/collaboration_criteria.md

View workflow job for this annotation

GitHub Actions / markdownlint

Table pipe style 

docs/search/collaboration_search_reference/collaboration_criteria.md:21:139 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md055.md
Copy link
Contributor Author

@mnocon mnocon Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes are TMP and done on purpose (928c29b) to see if they are detected correctly.

| Find invitations based on participant's scope, see [`ContentSessionScope`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Share-Collaboration-ContentSessionScope.html)

Check failure on line 22 in docs/search/collaboration_search_reference/collaboration_criteria.md

View workflow job for this annotation

GitHub Actions / markdownlint

Table pipe style 

docs/search/collaboration_search_reference/collaboration_criteria.md:22:178 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md055.md
for content-sharing sessions |

Check failure on line 23 in docs/search/collaboration_search_reference/collaboration_criteria.md

View workflow job for this annotation

GitHub Actions / markdownlint

Table pipe style 

docs/search/collaboration_search_reference/collaboration_criteria.md:23:2 MD055/table-pipe-style Table pipe style [Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md055.md
| [ParticipantType](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-ParticipantType.html) | Find invitations based on participant type, see [`ParticipantDiscriminator`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Participant-ParticipantDiscriminator.html) |
| [Sender](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-Sender.html) | Find invitations by invitation sender |
| [Session](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Collaboration-Invitation-Query-Criterion-Session.html) | Find invitations by collaboration session |
Expand Down
2 changes: 1 addition & 1 deletion docs/templating/components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ You can use an unique group name when creating a Twig Component to create your o
| [HTML](https://github.com/ibexa/twig-components/blob/main/src/lib/Component/HtmlComponent.php) | Renders static HTML |`html` |
| [Menu](https://github.com/ibexa/twig-components/blob/main/src/lib/Component/MenuComponent.php) | Renders a [menu](https://symfony.com/bundles/KnpMenuBundle/current/index.html) |`menu` |
| [Script](https://github.com/ibexa/twig-components/blob/main/src/lib/Component/ScriptComponent.php) | Renders a [`<script>` tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/script) | `script` |
| [Stylesheet](https://github.com/ibexa/twig-components/blob/main/src/lib/Component/LinkComponent.php) | Renders a [`<link>` tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/link) | `stylesheet`
| [Stylesheet](https://github.com/ibexa/twig-components/blob/main/src/lib/Component/LinkComponent.php) | Renders a [`<link>` tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/link) | `stylesheet` |
| [Template](https://github.com/ibexa/twig-components/blob/main/src/lib/Component/TemplateComponent.php) | Renders a Twig template|`template` |

For the menu component, the following properties are available:
Expand Down
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@
"repository": "git@github.com:ibexa/documentation-developer.git",
"scripts": {
"scss": "sass --watch scss:docs/css",
"markdownlint": "markdownlint-cli2 \"docs/**/*.md\"",
"test": "yarn prettier-test && yarn eslint-test",
"fix": "yarn prettier-test --write && yarn eslint-test --fix",
"eslint-test": "eslint \"./docs/js/**/*.js\"",
"prettier-test": "yarn prettier \"./code_samples/**/*.{js,scss}\" --check"
},
"prettier": "eslint-config-ibexa/prettier",
"devDependencies": {
"eslint-config-ibexa": "https://github.com/ibexa/eslint-config-ibexa.git#~v1.1.1"
"eslint-config-ibexa": "https://github.com/ibexa/eslint-config-ibexa.git#~v1.1.1",
"markdownlint-cli2": "^0.21.0"
},
"dependencies": {
"sass": "^1.82.0"
Expand Down
Loading