From d83b58fd9d893ad7a8de6490018d8096c0cedf84 Mon Sep 17 00:00:00 2001
From: Geert Eltink <geert.eltink@gmail.com>
Date: Sat, 15 May 2021 10:59:32 +0200
Subject: [PATCH] docs: fix markdown formatting

Signed-off-by: Geert Eltink <geert.eltink@gmail.com>
---
 docs/book/v1/intro.md              |  5 +++++
 docs/book/v1/ruleset.md            | 15 ++++++++++-----
 docs/book/v2/coding-style-guide.md | 17 +++++++++--------
 docs/book/v2/intro.md              | 29 +++++++++++++++++------------
 4 files changed, 41 insertions(+), 25 deletions(-)

diff --git a/docs/book/v1/intro.md b/docs/book/v1/intro.md
index 9b03b3d..cc7646e 100644
--- a/docs/book/v1/intro.md
+++ b/docs/book/v1/intro.md
@@ -3,11 +3,13 @@
 ## Installation
 
 1. Install the module via Composer by running:
+
    ```bash
    $ composer require --dev laminas/laminas-coding-standard
    ```
 
 2. Add Composer scripts into your `composer.json`:
+
    ```json
    "scripts": {
      "cs-check": "phpcs",
@@ -16,6 +18,7 @@
    ```
 
 3. Create file `phpcs.xml` on base path of your repository with content:
+
    ```xml
    <?xml version="1.0"?>
    <ruleset name="Laminas Coding Standard">
@@ -34,11 +37,13 @@ For a reference please see: https://github.com/squizlabs/PHP_CodeSniffer/wiki/An
 ## Usage
 
 * To run checks only:
+
   ```bash
   $ composer cs-check
   ```
 
 * To automatically fix many CS issues:
+
   ```bash
   $ composer cs-fix
   ```
diff --git a/docs/book/v1/ruleset.md b/docs/book/v1/ruleset.md
index 0e39c37..012ef6e 100644
--- a/docs/book/v1/ruleset.md
+++ b/docs/book/v1/ruleset.md
@@ -1,16 +1,21 @@
 # Ruleset
 
 ## Use PSR-2 coding standard as a base
-*PSR2*
+
+Rule: *PSR2*
 
 ## Disallow long array syntax
-*Generic.Arrays.DisallowLongArraySyntax*
+
+Rule: *Generic.Arrays.DisallowLongArraySyntax*
 
 ## Force whitespace after `!`
-*Generic.Formatting.SpaceAfterNot*
+
+Rule: *Generic.Formatting.SpaceAfterNot*
 
 ## Forbid spaces before semicolon `;`
-*Squiz.WhiteSpace.SemicolonSpacing*
+
+Rule: *Squiz.WhiteSpace.SemicolonSpacing*
 
 ## Forbid superfluous whitespaces
-*Squiz.WhiteSpace.SuperfluousWhitespace, Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines*
+
+Rule: *Squiz.WhiteSpace.SuperfluousWhitespace, Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines*
diff --git a/docs/book/v2/coding-style-guide.md b/docs/book/v2/coding-style-guide.md
index 2e6f5c7..9e6480c 100644
--- a/docs/book/v2/coding-style-guide.md
+++ b/docs/book/v2/coding-style-guide.md
@@ -257,14 +257,14 @@ each of the blocks below MUST be separated by a single blank line, and MUST NOT
 a blank line. Each block MUST be in the order listed below, although blocks that are
 not relevant may be omitted.
 
-* Opening `<?php` tag.
-* File-level docblock.
-* One or more declare statements.
-* The namespace declaration of the file.
-* One or more class-based `use` import statements.
-* One or more function-based `use` import statements.
-* One or more constant-based `use` import statements.
-* The remainder of the code in the file.
+- Opening `<?php` tag.
+- File-level docblock.
+- One or more declare statements.
+- The namespace declaration of the file.
+- One or more class-based `use` import statements.
+- One or more function-based `use` import statements.
+- One or more constant-based `use` import statements.
+- The remainder of the code in the file.
 
 When a file contains a mix of HTML and PHP, any of the above sections may still
 be used. If so, they MUST be present at the top of the file, even if the
@@ -1105,6 +1105,7 @@ $variable = $foo ? 'foo' : 'bar';
 
 When the middle operand of the conditional operator is omitted, the operator
 MUST follow the same style rules as other binary [comparison][] operators:
+
 ```php
 $variable = $foo ?: 'bar';
 ```
diff --git a/docs/book/v2/intro.md b/docs/book/v2/intro.md
index 8d010b8..1ff57ee 100644
--- a/docs/book/v2/intro.md
+++ b/docs/book/v2/intro.md
@@ -1,7 +1,7 @@
 # Introduction
 
-**This specification extends and expands [PSR-12](https://github.com/php-fig/fig-standards/blob/master/proposed/extended-coding-style-guide.md), 
-the extended coding style guide and requires adherence to [PSR-1](https://www.php-fig.org/psr/psr-1), 
+**This specification extends and expands [PSR-12](https://github.com/php-fig/fig-standards/blob/master/proposed/extended-coding-style-guide.md),
+the extended coding style guide and requires adherence to [PSR-1](https://www.php-fig.org/psr/psr-1),
 the basic coding standard.**
 
 These are minimal specifications and don't address all factors, including things like:
@@ -13,18 +13,20 @@ These are minimal specifications and don't address all factors, including things
 - what and what not to import, and how
 - etc.
 
-Contributors have different coding styles and so do the maintainers. During code reviews there are regularly 
-discussions about spaces and alignments, where and when was said that a function needs to be imported. And 
+Contributors have different coding styles and so do the maintainers. During code reviews there are regularly
+discussions about spaces and alignments, where and when was said that a function needs to be imported. And
 that's where this coding standard comes in: To have internal consistency in a component and between components.
 
 ## Installation
 
 1. Install the module via Composer by running:
+
    ```bash
    $ composer require --dev laminas/laminas-coding-standard
    ```
 
 2. Add Composer scripts into your `composer.json`:
+
    ```json
    "scripts": {
      "cs-check": "phpcs",
@@ -33,25 +35,26 @@ that's where this coding standard comes in: To have internal consistency in a co
    ```
 
 3. Create file `phpcs.xml` on base path of your repository with this content:
+
    ```xml
    <?xml version="1.0"?>
    <ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
-   
+
        <arg name="basepath" value="."/>
        <arg name="cache" value=".phpcs-cache"/>
        <arg name="colors"/>
        <arg name="extensions" value="php"/>
        <arg name="parallel" value="80"/>
-       
+
        <!-- Show progress -->
        <arg value="p"/>
-   
+
        <!-- Paths to check -->
        <file>config</file>
        <file>src</file>
        <file>test</file>
-   
+
        <!-- Include all rules from the Laminas Coding Standard -->
        <rule ref="LaminasCodingStandard"/>
    </ruleset>
@@ -62,12 +65,14 @@ the ["Annotated Ruleset" of PHP_CodeSniffer](https://github.com/squizlabs/PHP_Co
 
 ## Usage
 
-* To run checks only:
+- To run checks only:
+
   ```bash
   $ composer cs-check
   ```
 
-* To automatically fix many CS issues:
+- To automatically fix many CS issues:
+
   ```bash
   $ composer cs-fix
   ```
@@ -109,7 +114,7 @@ $xmlPackage->send();
 > should always be based on the develop branch and queued for the next major
 > release, unless considered a bugfix for existing rules.
 
-If you want to test changes against Laminas components or your own projects, install your forked 
+If you want to test changes against Laminas components or your own projects, install your forked
 laminas-coding-standard globally with Composer:
 
 ```bash
@@ -124,7 +129,7 @@ $ phpcs -sp --standard=LaminasCodingStandard src test
 **Make sure you remove the global installation after testing from your global
 `composer.json` file!**
 
-Documentation can be previewed locally by installing [MkDocs](https://www.mkdocs.org/#installation) and run 
+Documentation can be previewed locally by installing [MkDocs](https://www.mkdocs.org/#installation) and run
 `mkdocs serve`. This will start a server where you can read the docs.
 
 ## Reference