diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 0cc17626..b9f4aa03 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -49,3 +49,15 @@ jobs:
with:
reporter: github-check
filter_mode: added
+
+ 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"
diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml
new file mode 100644
index 00000000..9bb72b7b
--- /dev/null
+++ b/.markdownlint-cli2.yaml
@@ -0,0 +1,47 @@
+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
+
+ no-alt-text: true
+ first-line-heading: true
+ list-marker-space: true
+ blanks-around-fences: true
+ single-title: true
+ no-multiple-space-atx: true
+ blanks-around-headings: true
+ ul-style: dash
+ ol-prefix:
+ style: one_or_ordered
+ ul-indent:
+ indent: 4
+ heading-increment: true
+ blanks-around-tables: true
+ descriptive-link-text: true
+ single-trailing-newline: true
+ no-space-in-code: true
+ no-space-in-links: true
+ fenced-code-language: true
+ no-multiple-blanks: true
+ commands-show-output: true
+ no-trailing-spaces: true
+ blanks-around-lists: true
+ no-trailing-punctuation:
+ punctuation: [".", ":", ";",]
+ no-emphasis-as-heading: true
+ table-column-count: true
+
+ignores:
+ - "docs/snippets/**"
+ - "docs/index.md"
diff --git a/docs/ai_actions/work_with_ai_actions.md b/docs/ai_actions/work_with_ai_actions.md
index 0c00a3fb..7586220b 100644
--- a/docs/ai_actions/work_with_ai_actions.md
+++ b/docs/ai_actions/work_with_ai_actions.md
@@ -109,7 +109,7 @@ For a list of available settings, see [Edit existing AI actions](#edit-existing-
### Create AI actions that control taxonomy suggestions
-If the [Taxonomy suggestions]([[= developer_doc =]]/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, before editors can use it to pick from product categories or tags suggested by an AI service, you must configure an AI action for the product types or content types of your choice.
+If the [Taxonomy suggestions]([[= developer_doc =]]/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, before editors can use it to pick from product categories or tags suggested by an AI service, you must configure an AI action for the product types or content types of your choice.
1. Navigate to the Admin Panel and select **AI actions**.
@@ -120,7 +120,7 @@ If the [Taxonomy suggestions]([[= developer_doc =]]/content_management/taxonomy/
- **Language** - sets the base language for the AI action
- **Action type** - sets an action type to serve as a template for the AI action, for example, **Suggest taxonomy**
- **Action handler** - sets the AI model used to process the requests resulting from this AI action.
- Pick `taxonomy-text-to-taxonomy`
+ Pick `taxonomy-text-to-taxonomy`
1. Make settings in the **Global properties** section, as described above.
@@ -174,7 +174,7 @@ You must then fine-tune its settings in [[= product_name_connect =]].
7\. Click **Save and close** to apply the changes or **Discard** to discard them and close the window.
-After you save the AI action, you can click its name in the AI actions list and see all the information, such as Scenario ID, webhook URL, or scenario label, which you may needed when working with scenarios in [[= product_name_connect =]].
+After you save the AI action, you can click its name in the AI actions list and see all the information, such as Scenario ID, webhook URL, or scenario label, which you may needed when working with scenarios in [[= product_name_connect =]].
## Duplicate AI actions
diff --git a/docs/commerce/commerce.md b/docs/commerce/commerce.md
index b424b25a..2c11496c 100644
--- a/docs/commerce/commerce.md
+++ b/docs/commerce/commerce.md
@@ -29,4 +29,4 @@ Once the order is placed, users can interact with it by working with the followi
"commerce/payment/payment_management",
"commerce/shipping_management/shipping_management",
"commerce/discounts/discounts"
-], columns=3) =]]
+], columns=3) =]]
diff --git a/docs/commerce/discounts/discounts.md b/docs/commerce/discounts/discounts.md
index 9b568a4e..053b0ec7 100644
--- a/docs/commerce/discounts/discounts.md
+++ b/docs/commerce/discounts/discounts.md
@@ -15,12 +15,12 @@ Depending on the permissions assigned to your [user role](permissions_and_users.
For example, you can create time-limited offers on selected products, ones that apply only to specified regions, currencies, products or customers, or reward your newsletter subscribers with special discount codes.
-### Interaction with other modules
+## Interaction with other modules
The **Discounts** module interacts with other parts of the system, so that store customers can:
- in the product catalog, see base prices of products together with prices reduced according to active catalog discounts
-- in the cart, see prices reduced according to catalog and/or cart discounts, apply discount codes, and observe as prices change when various cart discount conditions are met
+- in the cart, see prices reduced according to catalog and/or cart discounts, apply discount codes, and observe as prices change when various cart discount conditions are met
- at checkout, see a total value of all applied discounts and prices reduced as a result of those discounts
For more information about discounts, see [Work with discounts](work_with_discounts.md).
diff --git a/docs/commerce/discounts/work_with_discounts.md b/docs/commerce/discounts/work_with_discounts.md
index 2d1a7d05..eb15d12c 100644
--- a/docs/commerce/discounts/work_with_discounts.md
+++ b/docs/commerce/discounts/work_with_discounts.md
@@ -43,7 +43,7 @@ To disable the offending discount, find it in the discount list and, in its line
To view the details of a discount, click its line in the discount list.
On the discount details screen, you can see an overview of the discount's details.
-Discount details include basic information about the discount:
+Discount details include basic information about the discount:
- validity period and value of the discount
- region and currency that the discount applies to
@@ -102,7 +102,7 @@ Cart discount applicability can be further limited by setting a number of condit
1. If your store supports multiple markets, you can select a region that the discount applies to.
1. If you are creating a fixed-amount discount, select a currency of the discount.
-
+
1. In the **Promotion information** area, provide a name and description of the promotional campaign, as they should be shown to customers.
@@ -110,15 +110,14 @@ Cart discount applicability can be further limited by setting a number of condit
1. Click **Next** to go to the next screen.
-
-
+
4. In the **Target group** screen, select customers that the new discount is targeted at.
You can choose everyone, or select one or more customer groups.
5. In the **Products** screen, select products that the discount applies to. You can choose between:
-
+
- all products from the catalog, for example, to clear stock before the end of year
- products from a specific category, for example, promotional gadgets for company partners
- specific products or even product variants, to activate slow-moving inventory
@@ -134,14 +133,14 @@ You can choose everyone, or select one or more customer groups.
- entered a specified discount code
If you set the discount code, you can set the number of times that the code can be used:
-
+
- by a certain customer
- in total, by all customers
7. In the **Discount value** screen, if you are creating a percentage-based discount, in **Customer gets discount value**, enter a percent value that the system uses to calculate the amount deducted from the base price of the product.
-Otherwise, enter a monetary value to be deducted from the base price.
+Otherwise, enter a monetary value to be deducted from the base price.
8. In the **Summary** screen, review the details of the discount that you are creating, and click **Save and close** to save the discount.
Depending on the settings, you may see a warning message.
diff --git a/docs/commerce/payment/work_with_payment_methods.md b/docs/commerce/payment/work_with_payment_methods.md
index 7dd46fb8..5a873d25 100644
--- a/docs/commerce/payment/work_with_payment_methods.md
+++ b/docs/commerce/payment/work_with_payment_methods.md
@@ -73,4 +73,4 @@ Payment methods describe the way store customers pay for their orders during the
- Method type - method of the payment
- Availability - payment method availability: Active, Inactive
-3. Click **Apply** to confirm.
\ No newline at end of file
+3. Click **Apply** to confirm.
diff --git a/docs/commerce/shipping_management/shipping_management.md b/docs/commerce/shipping_management/shipping_management.md
index 2cadb8d3..029db090 100644
--- a/docs/commerce/shipping_management/shipping_management.md
+++ b/docs/commerce/shipping_management/shipping_management.md
@@ -19,4 +19,4 @@ The **Shipping management** module interacts with other packages of the system,
[[= cards([
"commerce/shipping_management/work_with_shipping_methods",
"commerce/shipping_management/work_with_shipments"
-], columns=2) =]]
\ No newline at end of file
+], columns=2) =]]
diff --git a/docs/commerce/shipping_management/work_with_shipments.md b/docs/commerce/shipping_management/work_with_shipments.md
index 28676a74..ee9deae8 100644
--- a/docs/commerce/shipping_management/work_with_shipments.md
+++ b/docs/commerce/shipping_management/work_with_shipments.md
@@ -68,4 +68,4 @@ If your [user role](work_with_permissions.md) has the `Shipment/Edit` permission
- "Pending" -> "Ready to ship" - click **Prepare** button, then click **Change** to confirm.
- "Ready to ship" -> "Shipped" - click **Send** button, then click **Change** to confirm.
-- "Shipped" -> "Delivered" - click **Deliver** button, then click **Change** to confirm.
\ No newline at end of file
+- "Shipped" -> "Delivered" - click **Deliver** button, then click **Change** to confirm.
diff --git a/docs/commerce/shipping_management/work_with_shipping_methods.md b/docs/commerce/shipping_management/work_with_shipping_methods.md
index bb5231e6..787ac344 100644
--- a/docs/commerce/shipping_management/work_with_shipping_methods.md
+++ b/docs/commerce/shipping_management/work_with_shipping_methods.md
@@ -82,4 +82,4 @@ This value is then displayed during checkout and added to the total order amount
- Availability - shipping method availability: Active, Inactive
- Region - region that the shipping method applies to
-3. Click **Apply** to confirm.
\ No newline at end of file
+3. Click **Apply** to confirm.
diff --git a/docs/content_management/configure_ct_field_settings.md b/docs/content_management/configure_ct_field_settings.md
index f97aecc4..a962da96 100644
--- a/docs/content_management/configure_ct_field_settings.md
+++ b/docs/content_management/configure_ct_field_settings.md
@@ -46,7 +46,7 @@ All sections are later presented as headers on the content item details screen,
Depending on their type, fields can have different combinations of the following general settings.
|Setting|Description|Use|
---------|-----------|---|
+|-------|-----------|---|
|Name|A user-friendly name that describes the field, used in the interface. It can be up to 255 characters long and consist of letters, digits, spaces, and special characters.|Required|
|Identifier|An identifier for system use in configuration files, templates, or PHP code. It can be up to 50 characters long and can only contain lowercase letters, digits and underscores. Also used in name patterns for the content type.|Required|
|Description|A detailed description of the field. It's displayed next to it when the user edits the content item.|Optional|
@@ -102,7 +102,7 @@ When you add or modify a **[Content relation](create_edit_content_items.md#relat
- which content tree location opens in the [content browser](discover_ui.md#content-browser) when the user browses to a related content item
- whether relations can be to content items of a specific type only, or any content type
-#### Relation starting location
+### Relation starting location
In the **Select starting Location** area, select from the available options:
@@ -113,7 +113,7 @@ In the **Select starting Location** area, select from the available options:
-#### Allowed content types
+### Allowed content types
In the **Allowed content types** area, expand the drop-down list and select from the available content types.
No selection means that relations to all content types are allowed.
diff --git a/docs/content_management/content_management.md b/docs/content_management/content_management.md
index 8514219a..a12a85e4 100644
--- a/docs/content_management/content_management.md
+++ b/docs/content_management/content_management.md
@@ -31,4 +31,4 @@ It also involves content translation and publication scheduling.
"content_management/content_organization/copy_move_hide_content",
"content_management/content_organization/classify_content",
"content_management/content_organization/manage_locations_urls"
-], columns=3) =]]
\ No newline at end of file
+], columns=3) =]]
diff --git a/docs/content_management/content_model.md b/docs/content_management/content_model.md
index 90dac427..5cf1761a 100644
--- a/docs/content_management/content_model.md
+++ b/docs/content_management/content_model.md
@@ -66,4 +66,4 @@ By default, the system comes with a large set of field types that cover the most
!!! note "More information"
- For detailed information about the content model, see [Developer Documentation]([[= developer_doc =]]/content_management/content_model/#content-information).
\ No newline at end of file
+ For detailed information about the content model, see [Developer Documentation]([[= developer_doc =]]/content_management/content_model/#content-information).
diff --git a/docs/content_management/content_organization/classify_content.md b/docs/content_management/content_organization/classify_content.md
index 008d6cb0..4b0e9384 100644
--- a/docs/content_management/content_organization/classify_content.md
+++ b/docs/content_management/content_organization/classify_content.md
@@ -68,4 +68,4 @@ You can create and configure segments and segment groups in the **Admin** sectio
Assigning users to segments happens automatically according to rules set up by the administrator.
Contact your website administrator for more information about your setup.
-
\ No newline at end of file
+
diff --git a/docs/content_management/content_organization/copy_move_hide_content.md b/docs/content_management/content_organization/copy_move_hide_content.md
index 66e23166..2f5bdfb0 100644
--- a/docs/content_management/content_organization/copy_move_hide_content.md
+++ b/docs/content_management/content_organization/copy_move_hide_content.md
@@ -93,4 +93,4 @@ This is different from [hiding locations](manage_locations_urls.md#hide-location
and set a different section or object state for the given content.
Or use other permission-based [**Limitations**](work_with_permissions.md).
-
\ No newline at end of file
+
diff --git a/docs/content_management/create_edit_content_items.md b/docs/content_management/create_edit_content_items.md
index 953ddd22..c3eb6c81 100644
--- a/docs/content_management/create_edit_content_items.md
+++ b/docs/content_management/create_edit_content_items.md
@@ -64,7 +64,7 @@ month_change: true
To help you preserve your work, [[= product_name =]] saves drafts of content items automatically.
For more information, see [Autosave](content_versions.md#autosave).
-##### Upload multiple content items
+### Upload multiple content items
When you view the content item details in the content tree, you can upload files such as images, videos, or PDF documents.
This way you can add multiple sub-items without editing the original content item.
@@ -272,7 +272,7 @@ For this feature to work as described, the content type must have a **Metadata**
-!!! note "Taxonomy suggestions"
+!!! note "Taxonomy suggestions"
If the [Taxonomy suggestions]([[= developer_doc =]]/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, instead of manually browsing the taxonomy tree and selecting tags one by one, you can click **AI Suggest category** and pick from suggestions made by the AI Assistant.
diff --git a/docs/content_management/create_edit_content_types.md b/docs/content_management/create_edit_content_types.md
index 27b1ab9f..5503a0ae 100644
--- a/docs/content_management/create_edit_content_types.md
+++ b/docs/content_management/create_edit_content_types.md
@@ -44,7 +44,7 @@ For example, when you add or remove a field to the content type, the change is p
Each content type has the following global properties:
|Setting|Description|Use|
---------|-----------|---|
+|-------|-----------|---|
|Name|A name of the content type.|Required|
|Identifier|A unique identifier of the content type in the system. Up to 50 characters and can only consist of letters, numbers and underscores.|Required|
|Description|Additional information that is displayed when a content item is created based on this type.|Optional|
diff --git a/docs/content_management/create_edit_pages.md b/docs/content_management/create_edit_pages.md
index 55878367..52d56eff 100644
--- a/docs/content_management/create_edit_pages.md
+++ b/docs/content_management/create_edit_pages.md
@@ -270,4 +270,4 @@ There are several options for saving work on the page:
|Save draft|Save the page draft*.|
|Delete draft|Delete the page draft.|
-* To help you preserve your work, system saves drafts of content items automatically. For more information, see [Autosave](content_versions.md#autosave).
+- To help you preserve your work, system saves drafts of content items automatically. For more information, see [Autosave](content_versions.md#autosave).
diff --git a/docs/content_management/preview_content_items.md b/docs/content_management/preview_content_items.md
index 369f350c..1c97c8d3 100644
--- a/docs/content_management/preview_content_items.md
+++ b/docs/content_management/preview_content_items.md
@@ -32,4 +32,4 @@ Additionally, if you select a specific SiteAccess from the **Site context** drop
- if you [disable the Focus mode](../getting_started/discover_ui.md#disable-focus-mode) or click **Exit full view**, the **View** tab appears in the content item's details view, where you can quickly preview the content item
\ No newline at end of file
+switch between sites and views" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; color-scheme: light;" >
diff --git a/docs/content_management/publish_instantly.md b/docs/content_management/publish_instantly.md
index 0181a953..80863b29 100644
--- a/docs/content_management/publish_instantly.md
+++ b/docs/content_management/publish_instantly.md
@@ -14,7 +14,7 @@ All these options are available in the menu when you're in the edit mode.
-### Publishing vs. saving
+## Publishing vs. saving
Clicking **Save** doesn't immediately publish the content item.
Instead, it saves the [new version](content_versions.md) of the content as a draft.
diff --git a/docs/content_management/schedule_publishing.md b/docs/content_management/schedule_publishing.md
index 0909c5e9..cc4f19d6 100644
--- a/docs/content_management/schedule_publishing.md
+++ b/docs/content_management/schedule_publishing.md
@@ -121,7 +121,6 @@ You can select multiple events of the same type and perform bulk actions on them
Actions available in the toolbar may vary depending on the custom configuration.
For details, contact your page administrator.
-
To select, click on all events of the same type you want to add to the toolbar list.
@@ -136,7 +135,7 @@ These buttons are available on the **My dashboard** screen, and in the Calendar
||Reschedule all selected events.|
||Cancel the future publication of selected events.|
-#### Reschedule or cancel in the dashboard
+### Reschedule or cancel in the dashboard
To reschedule or cancel events with the dashboard, perform the following actions:
@@ -151,7 +150,7 @@ To reschedule or cancel events with the dashboard, perform the following actions
-#### Reschedule or cancel in Calendar
+### Reschedule or cancel in Calendar
In the [Calendar widget](#calendar-widget), select all events to have their publication time rescheduled or cancelled.
Using the toolbar buttons, perform one of the following actions:
diff --git a/docs/content_management/workflow_management/editorial_workflow.md b/docs/content_management/workflow_management/editorial_workflow.md
index 791bb52e..7724c04c 100644
--- a/docs/content_management/workflow_management/editorial_workflow.md
+++ b/docs/content_management/workflow_management/editorial_workflow.md
@@ -29,4 +29,4 @@ In the Review queue table, you can access the draft for editing, review its hist
For more information, see [Work with versions](work_with_versions.md).
-
\ No newline at end of file
+
diff --git a/docs/content_management/workflow_management/view_workflow_list.md b/docs/content_management/workflow_management/view_workflow_list.md
index 5c128140..03ec5e44 100644
--- a/docs/content_management/workflow_management/view_workflow_list.md
+++ b/docs/content_management/workflow_management/view_workflow_list.md
@@ -16,4 +16,4 @@ You can also select a configured workflow to see all content items that are unde
-For more information about configuring workflows, see [Developer Documentation]([[= developer_doc =]]/content_management/workflow/workflow/).
\ No newline at end of file
+For more information about configuring workflows, see [Developer Documentation]([[= developer_doc =]]/content_management/workflow/workflow/).
diff --git a/docs/content_management/workflow_management/work_with_versions.md b/docs/content_management/workflow_management/work_with_versions.md
index cbcd6542..40a21d5f 100644
--- a/docs/content_management/workflow_management/work_with_versions.md
+++ b/docs/content_management/workflow_management/work_with_versions.md
@@ -7,7 +7,6 @@ description: Perform various tasks on content item versions, as part of editoria
In [[= product_name =]], content items can have one published [version](../content_versions.md), and several draft and archived versions.
You can perform various tasks on content item versions, either to advance them through the workflow or compare edits from different users.
-
## Edit drafts
If you're assigned to a draft version of a content item for [review](editorial_workflow.md), when you click the **Edit draft** icon in **My dashboard**, the **Review queue** table, you see the **Event(s)** timeline that lists all the transitions that this content has gone through.
diff --git a/docs/customer_management/build_customer_portal.md b/docs/customer_management/build_customer_portal.md
index a80e8a3b..529705e1 100644
--- a/docs/customer_management/build_customer_portal.md
+++ b/docs/customer_management/build_customer_portal.md
@@ -14,7 +14,7 @@ If you're unfamiliar with how Page Builder works, see [Create and edit Pages](cr
## Create Customer Portal
To create a new Customer Portal, go to **Content** and from the menu select **Content structure**.
-There, navigate to the root folder for your Customer Portals.
+There, navigate to the root folder for your Customer Portals.
If you don't have one, you can add it yourself.
Remember to specify its `location_id` in the configuration, you can find it under **Technical details**.
For more information, see [Configure Page Builder access to Customer Portal]([[= developer_doc =]]/customer_management/cp_page_builder/#configure-page-builder-access-to-customer-portal).
@@ -29,7 +29,7 @@ It's recommended to use Customer Portal containers to divide and store your port
If your project requires it, the Customer Portal containers can also be defined as root folders in the configuration.
First, select **Customer Portal** and name it appropriately.
-Next, navigate to the newly added container and create **Customer Portal Page**.
+Next, navigate to the newly added container and create **Customer Portal Page**.
diff --git a/docs/customer_management/customer_management.md b/docs/customer_management/customer_management.md
index 86c669b2..42738c4b 100644
--- a/docs/customer_management/customer_management.md
+++ b/docs/customer_management/customer_management.md
@@ -11,4 +11,4 @@ Customer management allows you to manage and view accounts for customers and org
"customer_management/build_customer_portal",
"customer_management/manage_customers",
"customer_management/company_self_registration"
-], columns=4) =]]
\ No newline at end of file
+], columns=4) =]]
diff --git a/docs/dam/ibexa_dam.md b/docs/dam/ibexa_dam.md
index 59aa92cc..a2e34f4a 100644
--- a/docs/dam/ibexa_dam.md
+++ b/docs/dam/ibexa_dam.md
@@ -84,4 +84,4 @@ The selected item is marked with a red dot in the upper-left corner.
To confirm the selection, in the bottom toolbar, click **Insert**.
You can only select one image at a time.
-To deselect the image, click the thumbnail again.
\ No newline at end of file
+To deselect the image, click the thumbnail again.
diff --git a/docs/getting_started/content_tree/content_tree.md b/docs/getting_started/content_tree/content_tree.md
index 63513790..6cc5df68 100644
--- a/docs/getting_started/content_tree/content_tree.md
+++ b/docs/getting_started/content_tree/content_tree.md
@@ -22,7 +22,7 @@ To simplify the content tree, big lists are collapsed and include a **Show more*
Click it to expand the branches of the tree.
**Collapse all** option, which is available in the context menu, closes all expanded sections.
-### Add folders
+## Add folders
You can organize the tree by creating additional folders and subfolders of the **Content structure**.
A similar procedure applies to other areas of the system where the tree hierarchy is used.
@@ -41,4 +41,4 @@ A similar procedure applies to other areas of the system where the tree hierarch
The newly created folder is now visible in the content tree.
-
\ No newline at end of file
+
diff --git a/docs/getting_started/dashboard/work_with_dashboard.md b/docs/getting_started/dashboard/work_with_dashboard.md
index a0b987c3..9e8fcd92 100644
--- a/docs/getting_started/dashboard/work_with_dashboard.md
+++ b/docs/getting_started/dashboard/work_with_dashboard.md
@@ -42,7 +42,7 @@ B. Dashboard blocks / Structure view toolbox
C. Buttons:
|Name|Icon|Use|
---------|-----------|----------
+|--------|-----------|---------|
|Fields||Edit dashboard name.|
|Switch layout||Switch layout for the dashboard.|
|Undo||Undo latest change.|
@@ -172,4 +172,4 @@ Select the dashboard to be set as active, and click **Save**.
You can also select active dashboard and switch between default and customized dashboard in the main dashboard view.
Click the three dots menu and use the **Switch to...** action.
-
\ No newline at end of file
+
diff --git a/docs/getting_started/discover_ui.md b/docs/getting_started/discover_ui.md
index 493b757a..648a5436 100644
--- a/docs/getting_started/discover_ui.md
+++ b/docs/getting_started/discover_ui.md
@@ -154,7 +154,7 @@ Help center is also [another place]([[= developer_doc =]]/administration/admin_p
-Contents of the help center are contextual:
+Contents of the help center are contextual:
- If you are an [editor](editor.md) or [store manager](shop_manager.md) working in a production environment, help center contains links to user documentation, release notes and product roadmap highlights.
- If you are a developer whose task is to set up or extend the application, it additionally shows links to developer documentation, API references and the GraphQL console.
diff --git a/docs/getting_started/get_started.md b/docs/getting_started/get_started.md
index 5aa17c7e..93c912c5 100644
--- a/docs/getting_started/get_started.md
+++ b/docs/getting_started/get_started.md
@@ -98,7 +98,7 @@ Here you can [change your user password](get_started.md#change-the-password) and
#### Location
|Setting|Description|
---------|-----------|
+|-------|-----------|
|Default currency|Sets the default currency used in the back office.|
|Toggle In-Context translation feature|Enables or disables integration with Crowdin to navigate the interface while translating.|
|User Time Zone|Sets time zone in the back office.|
@@ -106,11 +106,10 @@ Here you can [change your user password](get_started.md#change-the-password) and
|Full date and time format|Sets full date and time format used in the back office.|
|Language|Sets the default language used in the back office.|
-
#### Content authoring
|Setting|Description|
---------|-----------|
+|-------|-----------|
|[Autosave draft every given period](content_versions.md#autosave)|Enables or disables autosaving drafts.|
|Seconds till next draft autosave|Sets time period for next autosave.|
|Enable character count in online editor|Enables or disables character count.|
@@ -119,7 +118,7 @@ Here you can [change your user password](get_started.md#change-the-password) and
#### Browsing
|Setting|Description|
---------|-----------|
+|-------|-----------|
|Number of items displayed in the table|Sets the number of items displayed in sub-items.|
|Location preview|Enables or disables a thumbnail preview on the content tree.|
|Help center|Enables or disables the [help center](discover_ui.md#help-center). [[% include 'snippets/lts-update_badge.md' %]]|
@@ -129,13 +128,13 @@ Here you can [change your user password](get_started.md#change-the-password) and
#### Mode
|Setting|Description|
---------|-----------|
+|-------|-----------|
|Focus mode|Enables or disables the [focus mode](discover_ui.md#focus-mode).|
#### Dashboard
|Setting|Description|
---------|-----------|
+|-------|-----------|
|Active dashboard|Sets which dashboard is displayed after you log in.|
### Change the password
diff --git a/docs/getting_started/notifications.md b/docs/getting_started/notifications.md
index f71b60f4..5a2ad9d8 100644
--- a/docs/getting_started/notifications.md
+++ b/docs/getting_started/notifications.md
@@ -22,7 +22,7 @@ When you receive a new notification, a badge appears on the notification icon, w
-If you have already received notifications and didn't act on then, a number of notifications on the badge increases when you receive another one.
+If you have already received notifications and didn't act on then, a number of notifications on the badge increases when you receive another one.
@@ -51,7 +51,7 @@ You can see all the notifications that you have received in the **Notifications*
!!! note "List pagination"
-
+
The list can take more than one screen. If it is so, you can click the arrows and numbers at the bottom of the screen to navigate the list.
2. Narrow down the list of displayed notifications by selecting one or more of the following filters:
diff --git a/docs/image_management/edit_images.md b/docs/image_management/edit_images.md
index 9ae7f43a..5b36ac18 100644
--- a/docs/image_management/edit_images.md
+++ b/docs/image_management/edit_images.md
@@ -44,9 +44,9 @@ Tagging image assets helps keep the media library organized and enables searchin
When you edit the image asset, you can edit the image itself by using the Image Editor that enables:
-* image cropping
-* image flipping
-* setting a point of focus within an image
+- image cropping
+- image flipping
+- setting a point of focus within an image
Image Editor is available whenever you see the **Edit** icon on the preview.
diff --git a/docs/permission_management/permission_system.md b/docs/permission_management/permission_system.md
index 2799cd59..55dd190e 100644
--- a/docs/permission_management/permission_system.md
+++ b/docs/permission_management/permission_system.md
@@ -6,7 +6,7 @@ description: Use the permission system to fine-tune the access control.
An overview of the permission system in [[= product_name =]] is best presented with an example.
-### Example permission system
+## Example permission system
Let us assume you're managing a newspaper website.
Your crew consists of an editor-in-chief and several editors responsible for particular sections of the paper, for example, general news, local news, or sports.
@@ -35,5 +35,4 @@ All of these roles have the same policies, but to each policy you need to assign
Aside from policies that define access to content items, there are also many other policy types concerned with administrating the system.
They cover actions, for example, activating new users, creating Sections, or modifying content types.
-
For more information about setting up a permission system, see [Work with permissions](work_with_permissions.md).
diff --git a/docs/permission_management/work_with_permissions.md b/docs/permission_management/work_with_permissions.md
index 63f905d2..044863da 100644
--- a/docs/permission_management/work_with_permissions.md
+++ b/docs/permission_management/work_with_permissions.md
@@ -35,4 +35,4 @@ You can then return to a list of policies by clicking **Save and close** or **Di
For a list of available permissions and limitations, see [Permissions]([[= developer_doc =]]/permissions/permissions/).
-
\ No newline at end of file
+
diff --git a/docs/persona_paths/manage_content_model.md b/docs/persona_paths/manage_content_model.md
index 575c3d95..b0eabbb6 100644
--- a/docs/persona_paths/manage_content_model.md
+++ b/docs/persona_paths/manage_content_model.md
@@ -11,4 +11,3 @@ Learn more and create or modify content types.
"content_management/content_model",
"content_management/create_edit_content_types"
], style="path") =]]
-
diff --git a/docs/persona_paths/manage_products.md b/docs/persona_paths/manage_products.md
index ea9d6f5d..c90c0db5 100644
--- a/docs/persona_paths/manage_products.md
+++ b/docs/persona_paths/manage_products.md
@@ -7,7 +7,6 @@ description: Add and configure products in your catalog, set up their attributes
In [[= product_name =]] you store aggregate product information in product catalog.
Learn to add, categorize and organize products, so that you have control over your stock and customers can easily browse your catalogs.
-
[[= cards([
"product_catalog/create_product_types",
"product_catalog/work_with_product_attributes",
diff --git a/docs/product_catalog/product_types.md b/docs/product_catalog/product_types.md
index 5c0fae44..2fc95901 100644
--- a/docs/product_catalog/product_types.md
+++ b/docs/product_catalog/product_types.md
@@ -31,7 +31,7 @@ When a product type is created, you can review its fields, attributes, and VAT r
If your [user role](../permission_management/work_with_permissions.md) has the `ProductType/Edit` permission, you can [modify product types and add individual attributes or attribute groups](create_product_types.md).
-### Attributes
+## Attributes
Unlike text fields that can be formatted and are intended to be displayed, product attributes precisely list product properties or specifications.
diff --git a/docs/product_catalog/products.md b/docs/product_catalog/products.md
index 61b55e30..1b72d123 100644
--- a/docs/product_catalog/products.md
+++ b/docs/product_catalog/products.md
@@ -25,7 +25,7 @@ Products can also be [embedded in content items](create_edit_content_items.md#em
For more information about creating products, see [Create product](create_edit_product.md#create-and-edit-products).
-### Product completeness
+## Product completeness
Before your customers can purchase products, the website [administrator must configure]([[= developer_doc =]]/product_catalog/enable_purchasing_products/) at least one region and one currency for the shop, and VAT rates for each of the regions.
You must then set:
diff --git a/docs/product_catalog/work_with_product_attributes.md b/docs/product_catalog/work_with_product_attributes.md
index 4f2462dd..c9a2e375 100644
--- a/docs/product_catalog/work_with_product_attributes.md
+++ b/docs/product_catalog/work_with_product_attributes.md
@@ -57,7 +57,7 @@ Each identifier must be unique. It can have up to 64 characters and contain only
Each identifier must be unique. It can have up to 64 characters and contain only letters, numbers, underscores, and dashes.
-4\. Select an attribute group to which the attribute is assigned.
+4\. Select an attribute group to which the attribute is assigned.
After you assign an attribute to a group and save your changes, the assignment can't be changed.
diff --git a/docs/product_catalog/work_with_product_categories.md b/docs/product_catalog/work_with_product_categories.md
index 37db02f2..16e848f1 100644
--- a/docs/product_catalog/work_with_product_categories.md
+++ b/docs/product_catalog/work_with_product_categories.md
@@ -41,11 +41,11 @@ Depending on your permissions, you might be able to verify the presence of the f
1. If the field is present, click **Delete draft** and skip the remaining steps.
2. If the field is absent, drag and drop the *Taxonomy Entry Assignment* option from the **Field types** area to the **Field definitions** area.
3. Expand the **New field type** that you added and make the following settings:
- * Set a name for the field, for example, "Product category"
- * Select the **Required** checkbox
- * In the **Taxonomy** field, select the "Product categories" taxonomy type
+ - Set a name for the field, for example, "Product category"
+ - Select the **Required** checkbox
+ - In the **Taxonomy** field, select the "Product categories" taxonomy type
4. Optionally, modify other product type settings as required.
-7. To save your changes:
+5. To save your changes:
- Click **Save** to continue editing.
- Click **Save and close** to close the window.
@@ -65,13 +65,13 @@ Similarly to other items in [[= product_name =]], you add product categories eit
2. To add a category using the **Create** button, in the category tree, select the category to which you want to add a child category. After the details of the selected category are loaded, click the **Create** button and skip to step 4.
3. To add a category directly in the category tree, click the three dots icon next to the category to which you want to add a child category. In the context menu, click **Add**.
4. In the product category editing modal, make the following settings:
- * Enter a unique identifier for the product category, for example, "HW_WIN".
- * Enter a unique name for the product category, "Devices with Windows".
- * Optionally, change the parent category of the currently edited category:
+ - Enter a unique identifier for the product category, for example, "HW_WIN".
+ - Enter a unique name for the product category, "Devices with Windows".
+ - Optionally, change the parent category of the currently edited category:
In the **Parent** area, click the **Change path** button. Then, in the **Select parent** modal, select a category from the tree and click **Select parent**.
- * Click **Save** to save the product category.
+ - Click **Save** to save the product category.
The newly created category can now be assigned to products.
@@ -96,7 +96,7 @@ You can create or change product category relationships with products in two way
-!!! note "Taxonomy suggestions"
+!!! note "Taxonomy suggestions"
If the [Taxonomy suggestions]([[= developer_doc =]]/content_management/taxonomy/taxonomy#taxonomy-suggestions) feature is enabled in your system, instead of manually browsing the product category tree and selecting categories one by one, you can click **AI Suggest category** and pick from suggestions made by the AI Assistant.
diff --git a/docs/product_catalog/work_with_product_variants.md b/docs/product_catalog/work_with_product_variants.md
index 9e946cd0..fdc7b6f3 100644
--- a/docs/product_catalog/work_with_product_variants.md
+++ b/docs/product_catalog/work_with_product_variants.md
@@ -16,7 +16,7 @@ If a product has only one attribute that can be used for variants, you can creat
If a product has more than one such attribute, you can create variants for any combination of attribute values.
For example, for a desk that has two top colors: `white` and `oak` and two frame colors: `black` and `grey`, you can create up to four variants: `white/black`, `white/grey`, `oak/black`, and `oak/grey`.
-### Generate variants
+## Generate variants
You can generate variants automatically based on the configured attributes.
@@ -32,19 +32,19 @@ To generate variants:
You can now see a list of all possible variants for the selected attribute values.
-### Delete variants
+## Delete variants
You can delete any generated product variant.
To do it, select one or more variants in the list and click the **Delete** button.
-### Manually create variants
+## Manually create variants
If needed, you can manually create any missing variants, including ones you previously deleted.
To do this, click **Add** next to the variant list, enter a product code and select attribute values for the new variant.
-### Manage variants
+## Manage variants
You can set up product availability separately for each product variant.
diff --git a/docs/recent_activity/recent_activity.md b/docs/recent_activity/recent_activity.md
index 768cd66d..6f271d77 100644
--- a/docs/recent_activity/recent_activity.md
+++ b/docs/recent_activity/recent_activity.md
@@ -45,8 +45,8 @@ Depending on the system configuration, activity logs may also be shown:
You can filter the activities to:
-* follow the activity of selected users or user group,
-* narrow the results to selected item types, or actions.
+- follow the activity of selected users or user group,
+- narrow the results to selected item types, or actions.
To do it, on the right side, in the **Filters** menu, choose selected filters, and click the **Apply** button.
Click the **Clear** button to reset all the filters.
diff --git a/docs/recommendations/raptor_integration/raptor_recommendation_blocks.md b/docs/recommendations/raptor_integration/raptor_recommendation_blocks.md
index faa3542d..060be042 100644
--- a/docs/recommendations/raptor_integration/raptor_recommendation_blocks.md
+++ b/docs/recommendations/raptor_integration/raptor_recommendation_blocks.md
@@ -300,7 +300,6 @@ On the **Properties** tab, set values in the following fields:
Toggle the **Show only available items** option on to display only products that are currently in stock.
-
!!! tip
For a list of all blocks available in Page Builder, see [Block reference](block_reference.md).
diff --git a/docs/search/search_for_content.md b/docs/search/search_for_content.md
index 706263e4..b933c998 100644
--- a/docs/search/search_for_content.md
+++ b/docs/search/search_for_content.md
@@ -50,4 +50,4 @@ Depending on the system configuration, a content item count can be indicated for
Select your filters, then click **Apply** to update the results.
Click **Clear** to reset and remove all filters.
-
\ No newline at end of file
+
diff --git a/package.json b/package.json
index 4397d8fe..0d2cc2ec 100644
--- a/package.json
+++ b/package.json
@@ -4,9 +4,11 @@
"main": "index.js",
"repository": "git@github.com:ezsystems/user-documentation.git",
"scripts": {
- "scss": "sass --watch scss:docs/css"
+ "scss": "sass --watch scss:docs/css",
+ "markdownlint": "markdownlint-cli2 \"docs/**/*.md\""
},
"dependencies": {
- "sass": "^1.82.0"
+ "sass": "^1.82.0",
+ "markdownlint-cli2": "^0.21.0"
}
}