Remove number prefixes from Markdown files

We used to have those to preserve the order of the pages when generating
the documentation with MkDocs. This commit introduces the
`mkdocs-nav-weight`, that allows us to make that order without having
those prefixes.

README.md

@@ -9,9 +9,9 @@
 The most awesome validation engine ever created for PHP.
 
 - Complex validation made simple: `v::numericVal()->positive()->between(1, 255)->isValid($input)`.
-- [Granularity control](docs/03-handling-exceptions.md) for advanced reporting.
-- [More than 150](docs/09-list-of-validators-by-category.md) (fully tested) validators.
-- [A concrete API](docs/06-concrete-api.md) for non fluent usage.
+- [Granularity control](docs/handling-exceptions.md) for advanced reporting.
+- [More than 150](docs/list-of-validators-by-category.md) (fully tested) validators.
+- [A concrete API](docs/concrete-api.md) for non fluent usage.
 
 Learn More:
 

docs/feature-guide.md

@@ -1,3 +1,7 @@
+---
+weight: -95
+---
+
 # Feature Guide
 
 The `ValidatorBuilder` class is the core of Respect\Validation, offering a fluent interface for building validators.

docs/index.md

@@ -3,6 +3,6 @@
 The most awesome validation engine ever created for PHP.
 
 - Complex validation made simple: `v::numericVal()->positive()->between(1, 255)->isValid($input)`.
-- [Granularity control](03-handling-exceptions.md) for advanced reporting.
-- [More than 150](09-list-of-validators-by-category.md) (fully tested) validators.
-- [A concrete API](06-concrete-api.md) for non fluent usage.
+- [Granularity control](handling-exceptions.md) for advanced reporting.
+- [More than 150](list-of-validators-by-category.md) (fully tested) validators.
+- [A concrete API](concrete-api.md) for non fluent usage.

docs/license.md

@@ -1,3 +1,7 @@
+---
+weight: -1
+---
+
 # License
 
 Copyright (c) [Alexandre Gomes Gaigalas](http://github.com/alganet).

docs/requirements.txt

@@ -1,3 +1,4 @@
 mkdocs>=1.5.0
 pymdown-extensions>=10.0
+mkdocs-nav-weight==0.3.0
 

docs/validators/Between.md

@@ -11,7 +11,7 @@ v::intVal()->between(10, 20)->isValid(20); // true
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../08-comparable-values.md).
+[comparable values](../comparable-values.md).
 
 Message template for this validator includes `{{minValue}}` and `{{maxValue}}`.
 

docs/validators/BetweenExclusive.md

@@ -13,7 +13,7 @@ v::betweenExclusive(0, 100)->isValid(100); // false
 v::betweenExclusive('a', 'z')->isValid('a'); // false
 ```
 
-Validation makes comparison easier, check out our supported [comparable values](../08-comparable-values.md).
+Validation makes comparison easier, check out our supported [comparable values](../comparable-values.md).
 
 ## Templates
 

docs/validators/GreaterThan.md

@@ -10,7 +10,7 @@ v::greaterThan(10)->isValid(9); // false
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../08-comparable-values.md).
+[comparable values](../comparable-values.md).
 
 Message template for this validator includes `{{compareTo}}`.
 

docs/validators/GreaterThanOrEqual.md

@@ -11,7 +11,7 @@ v::intVal()->greaterThanOrEqual(10)->isValid(11); // true
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../08-comparable-values.md).
+[comparable values](../comparable-values.md).
 
 Message template for this validator includes `{{compareTo}}`.
 

docs/validators/LessThan.md

@@ -10,7 +10,7 @@ v::lessThan(10)->isValid(10); // false
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../08-comparable-values.md).
+[comparable values](../comparable-values.md).
 
 Message template for this validator includes `{{compareTo}}`.
 

docs/validators/LessThanOrEqual.md

@@ -11,7 +11,7 @@ v::lessThanOrEqual(10)->isValid(11); // false
 ```
 
 Validation makes comparison easier, check out our supported
-[comparable values](../08-comparable-values.md).
+[comparable values](../comparable-values.md).
 
 Message template for this validator includes `{{compareTo}}`.
 

mkdocs.yml

@@ -1,6 +1,12 @@
 site_name: Respect\Validation
 theme: readthedocs
 
+plugins:
+  - search
+  - mkdocs-nav-weight:
+      index_weight: -100
+      default_page_weight: -50
+
 markdown_extensions:
   - pymdownx.highlight:
       anchor_linenums: true

src-dev/Commands/UpdateDocLinksCommand.php

@@ -168,7 +168,7 @@ final class UpdateDocLinksCommand extends Command
             $lines[] = sprintf('- [%1$s](validators/%1$s.md)', $validator);
         }
 
-        $outputFile = sprintf('%s/09-list-of-validators-by-category.md', $docsDirectory);
+        $outputFile = sprintf('%s/list-of-validators-by-category.md', $docsDirectory);
         file_put_contents($outputFile, trim(implode("\n", $lines)) . PHP_EOL);
     }