Use awesome-pages to customize the menus

We tried using `mkdocs-nav-weight` but it turned out quiet limited. Not
only we have to add specific frontmatter to the Markdown files, but we
could also not hide and sort directories.

This commit introduces awesome-pages, which allows us to customize the
order of pages and not list the content of the "validators" directory in
the left menu.

Author: henriquemoody

README.md

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

REUSE.toml

@@ -1,6 +1,6 @@
 version = 1
 
 [[annotations]]
-path = [ "*.yml", "*.yaml", ".git*", "*.dist", "composer.json", "tests/fixtures/*", ".github/*.yml", ".github/workflows/**.yml" ]
+path = [ "*.yml", "*.yaml", ".git*", "*.dist", "docs/.pages", "docs/validators/.pages", "composer.json", "tests/fixtures/*", ".github/*.yml", ".github/workflows/**.yml" ]
 SPDX-FileCopyrightText = "Respect Project Contributors"
 SPDX-License-Identifier = "MIT"

docs/.pages

@@ -0,0 +1,5 @@
+nav:
+  - index.md
+  - getting-started.md
+  - feature-guide.md
+  - ...

docs/feature-guide.md

@@ -1,9 +1,7 @@
----
-# SPDX-FileCopyrightText: (c) Respect Project Contributors
-# SPDX-License-Identifier: MIT
-
-weight: -95
----
+<!--
+SPDX-FileCopyrightText: (c) Respect Project Contributors
+SPDX-License-Identifier: MIT
+-->
 
 # Feature Guide
 

docs/getting-started.md

@@ -1,9 +1,7 @@
----
-# SPDX-FileCopyrightText: (c) Respect Project Contributors
-# SPDX-License-Identifier: MIT
-
-weight: -100
----
+<!--
+SPDX-FileCopyrightText: (c) Respect Project Contributors
+SPDX-License-Identifier: MIT
+-->
 
 # Getting Started
 
@@ -102,4 +100,4 @@ $validator->assert('validation');
 ## Next steps
 
 - Explore the [Feature Guide](feature-guide.md) for more advanced usage.
-- Check out the [List of Validators by Category](validators/index.md) for a comprehensive list of available validators.
+- Check out the [List of Validators by Category](validators.md) for a comprehensive list of available validators.

docs/index.md

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

docs/requirements.txt

@@ -3,5 +3,5 @@
 
 mkdocs>=1.5.0
 pymdown-extensions>=10.0
-mkdocs-nav-weight==0.3.0
+mkdocs-awesome-pages-plugin>=2.9.0