fix: Fix documentation typos & add documentation linter

.mega-linter.yml

@@ -5,4 +5,4 @@ ENABLE_LINTERS:
 VALIDATE_ALL_CODEBASE: true
 PYTHON_RUFF_CONFIG_FILE: pyproject.toml
 PYTHON_RUFF_ARGUMENTS: --force-exclude
-MARKDOWN_MARKDOWNLINT_ARGUMENTS: --disable MD046
+MARKDOWN_MARKDOWNLINT_ARGUMENTS: --disable MD046 --disable MD024

README.md

@@ -48,7 +48,7 @@ Python 3.10+ :snake: and Robot Framework 5.0+ :robot:.
 
 You can install the latest version of Robocop simply by running:
 
-```
+```commandline
 pip install -U robotframework-robocop
 ```
 
@@ -70,15 +70,15 @@ robocop format
 
 All command line options can be displayed in a help message by executing:
 
-```
+```commandline
 robocop -h
 ```
 
 ## Example Output
 
 Executing command:
 
-```
+```commandline
 robocop check --reports rules_by_error_type test.robot
 ```
 
@@ -212,15 +212,15 @@ readable and understandable by others, and Robocop can help to **uphold the law*
 
   For example:
 
-  ```
+  ```commandline
   robocop check --configure line-too-long.line_length=140
   ```
 
   ---
   Each rule's severity can also be overwritten. Possible values are
   `e/error`, `w/warning` or `i/info` and are case-insensitive. Example:
 
-  ```
+  ```commandline
   robocop check -c too-long-test-case.severity=e
   ```
 
@@ -230,7 +230,7 @@ readable and understandable by others, and Robocop can help to **uphold the law*
 
   Example:
 
-  ```
+  ```robotframework
   Keyword with lowercased name  # robocop: off
   ```
 
@@ -244,7 +244,8 @@ readable and understandable by others, and Robocop can help to **uphold the law*
 
   **Yes**, you can define and include custom rules using `--custom-rules` command line option
   by providing a path to a file containing your rule(s):
-  ```
+
+  ```commandline
   robocop --custom-rules my/own/rule.py --custom-rules external_rules.py
   ```
 

docs/configuration/configuration_reference.md

@@ -402,7 +402,7 @@ To only select and run rules with ``doc`` in their name:
     ]
     ```
 
-Use ``ALL`` keyword to select all rules (including rules disabled by default). You can combine it with ``--ignore`` 
+Use ``ALL`` keyword to select all rules (including rules disabled by default). You can combine it with ``--ignore``
 option to select all rules except those you want to ignore:
 
 === ":octicons-command-palette-24: cli"
@@ -811,7 +811,7 @@ See [the GitLab](../linter/reports/gitlab.md) page for more information.
 
 #### ``issue format``
 
-``--issue-format`` option allows configuring output format of issues. 
+``--issue-format`` option allows configuring output format of issues.
 
 It only affects ``simple`` output type. See [``print issues``](../linter/reports/print_issues.md) reporter to see all
 possible output types and their configuration.
@@ -976,7 +976,7 @@ By default, all formatters run in the same order. Whether called with:
 ```bash
 robocop format
 ```
-   
+
 or:
 
 ```bash

docs/formatter/formatters/AlignKeywordsSection.md

@@ -12,7 +12,7 @@ Align keyword calls and settings into columns with predefined width. There are t
 
 The width of the column sets the limit to the maximum width of the column. Default width is ``24``
 (see [widths](#widths) for information how to configure it).
-With ``fixed`` alignment each column has fixed width (and tokens that do not fit go into ``overflow`` state - see 
+With ``fixed`` alignment each column has fixed width (and tokens that do not fit go into ``overflow`` state - see
 [overflow](#overflow) for more information).
 
 ``auto`` alignment aligns tokens to the longest token in the column. The column width can be shorter than the

docs/formatter/formatters/AlignVariablesSection.md

@@ -67,7 +67,7 @@ You can configure it to align three columns:
     ```
 
 will result in the following formatting:
-   
+
 
 === "Before"
 

docs/formatter/formatters/Translate.md

@@ -63,7 +63,7 @@ Since the translation is from one or many languages to one, only one language ca
 
 ## Source language
 
-Robocop will translate only markers that can be recognized. If your source file is written in a different language, 
+Robocop will translate only markers that can be recognized. If your source file is written in a different language,
 you need to configure Robocop to recognize a given language. See :ref:`language_support` for more details.
 The following example configures Robocop to read English, Polish and German languages and translate Robot Framework
 markers to Ukrainian:

docs/index.md

@@ -9,31 +9,31 @@ a number of checks, looking for potential errors or violations to code quality s
 
 <div class="grid cards" markdown>
 
--   :book:{ .lg .middle } __Starting guide__
+- :book:{ .lg .middle } __Starting guide__
 
     ---
 
     See how to install and use Robocop
 
     [:octicons-arrow-right-24: User Guide](user_guide/intro.md)
 
--   :material-file-cog-outline:{ .lg .middle } __Configuration__
+- :material-file-cog-outline:{ .lg .middle } __Configuration__
 
     ---
 
     Configure Robocop to your needs
 
     [:octicons-arrow-right-24: Configuration](configuration/index.md)
 
--   :material-format-list-text:{ .lg .middle } __Linter__
+- :material-format-list-text:{ .lg .middle } __Linter__
 
     ---
 
     View the list of available linter rules
 
     [:octicons-arrow-right-24: Rules list](rules_list.md)
 
--   :material-broom:{ .lg .middle } __Formatter__
+- :material-broom:{ .lg .middle } __Formatter__
 
     ---
 

docs/linter/custom_rules.md

@@ -1,5 +1,3 @@
-from robocop.linter.fix import FixApplicabilityfrom robocop.linter.diagnostics import Diagnosticfrom robocop.linter.rules import FixableRule
-
 # Custom rules
 
 ## How to include custom rules

docs/linter/reports/print_issues.md

@@ -26,7 +26,7 @@ Use ``output_format`` parameter to configure an output format. Supported output
        |
 
     ```
-    
+
 - **grouped**, which prints issues grouped by source files:
 
     ```bash

docs/releasenotes/8.0.0.md

@@ -1,6 +1,6 @@
 # [8.0.0](https://github.com/MarketSquare/robotframework-robocop/compare/v7.2.0...v8.0.0) (2026-02-11)
 
-### Breaking changes
+## Breaking changes
 
 * dropped support for Python 3.9
 * dropped support for Robot Framework 4
@@ -33,7 +33,7 @@
   need to update the usage.
   It also affects Robotcode, but I have raised the appropriate fix PR, and it should be updated soon.
 
-### Features
+## Features
 
 * Fixable rules! (#1617) (128c849)