Merge pull request #2 from JordanRL/f-mkdocs-merge

Existing mkdocs.yml options

Author: JordanRL

composer.json

@@ -2,7 +2,7 @@
   "name": "samsara/roster",
   "type": "library",
   "description": "A PHP console tool to generate Markdown documentation from your docblocks and types hints using templates.",
-  "keywords": ["documentation", "markdown", "template", "console", "cli", "command line"],
+  "keywords": ["documentation", "markdown", "template", "console", "cli", "command line", "mkdocs", "rtd"],
   "funding": [
     {
       "type": "github",
@@ -25,6 +25,8 @@
   "require": {
     "symfony/console": "^v5.3",
     "samsara/mason": "^0.1",
+    "hassankhan/config": "^2.2",
+    "symfony/yaml": "^5.3",
     "php": ">=8.0"
   },
   "require-dev": {

doc-templates/roster-templates-mkdocs/mkdocs.yml

@@ -1,10 +1,9 @@
-site_name: {$siteName}
+site_name: ''
 extra_css:
   - css/roster-style.css
-repo_url: {$repoUrl}
-site_url: {$siteUrl}
-nav:
-{$navigation}
+repo_url: ''
+site_url: ''
+nav: []
 theme:
   name: readthedocs
   highlightjs: true

docs/roster/latest/Samsara/Roster/Roster.md

@@ -117,38 +117,30 @@
     **return**
 
     type
-    :   string
+    :   array|string
 
     description
     :   *No description available*
 
-!!! signature "protected Roster->buildNavArrayRecursive(array $parts, int $depth)"
-    **$parts**
+!!! signature "protected Roster->formatNavArrayRecursive(array $nav)"
+    **$nav**
 
     type
     :   array
 
     description
     :   *No description available*
 
-    **$depth**
-
-    type
-    :   int
-
-    description
-    :   *No description available*
-
     **return**
 
     type
-    :   array|string
+    :   array
 
     description
     :   *No description available*
 
-!!! signature "protected Roster->buildNavRecursive(array $navArray, int $depth, string $builtString)"
-    **$navArray**
+!!! signature "protected Roster->buildNavArrayRecursive(array $parts, int $depth, string $builtString)"
+    **$parts**
 
     type
     :   array
@@ -175,7 +167,7 @@
     **return**
 
     type
-    :   string
+    :   array|string
 
     description
     :   *No description available*

mkdocs.yml

@@ -1,45 +1,67 @@
-site_name: Roster - Docs From The Source
+site_name: 'Roster - Docs From The Source'
 extra_css:
-  - css/roster-style.css
-repo_url: https://github.com/JordanRL/Roster/
-site_url: https://jordanrl.github.io/Roster/
+    - css/roster-style.css
+repo_url: 'https://github.com/JordanRL/Roster/'
+site_url: 'https://jordanrl.github.io/Roster/'
 nav:
-  - 'Home': 'index.md'
-  - 'About':
-      - 'Installation': 'getting-started/installation.md'
-      - 'Using the Command': 'getting-started/using-the-command.md'
-  - 'Code Reference':
-      - 'Roster':
-          - 'TemplateFactory': 'roster/latest/Samsara/Roster/TemplateFactory.md'
-          - 'Roster': 'roster/latest/Samsara/Roster/Roster.md'
-          - 'App': 'roster/latest/Samsara/Roster/App.md'
-          - 'Processors':
-              - 'InterfaceInlineProcessor': 'roster/latest/Samsara/Roster/Processors/InterfaceInlineProcessor.md'
-              - 'TraitInlineProcessor': 'roster/latest/Samsara/Roster/Processors/TraitInlineProcessor.md'
-              - 'MethodArgumentDetailProcessor': 'roster/latest/Samsara/Roster/Processors/MethodArgumentDetailProcessor.md'
-              - 'ClassProcessor': 'roster/latest/Samsara/Roster/Processors/ClassProcessor.md'
-              - 'TemplateProcessor': 'roster/latest/Samsara/Roster/Processors/TemplateProcessor.md'
-              - 'PropertyProcessor': 'roster/latest/Samsara/Roster/Processors/PropertyProcessor.md'
-              - 'MethodArgumentProcessor': 'roster/latest/Samsara/Roster/Processors/MethodArgumentProcessor.md'
-              - 'MethodProcessor': 'roster/latest/Samsara/Roster/Processors/MethodProcessor.md'
-              - 'Base':
-                  - 'BaseCodeProcessor': 'roster/latest/Samsara/Roster/Processors/Base/BaseCodeProcessor.md'
-
+    -
+        Home: index.md
+    -
+        About:
+            -
+                Installation: getting-started/installation.md
+            -
+                'Using the Command': getting-started/using-the-command.md
+    -
+        'Code Reference':
+            -
+                Roster:
+                    -
+                        TemplateFactory: roster/latest/Samsara/Roster/TemplateFactory.md
+                    -
+                        Roster: roster/latest/Samsara/Roster/Roster.md
+                    -
+                        App: roster/latest/Samsara/Roster/App.md
+                    -
+                        Processors:
+                            -
+                                InterfaceInlineProcessor: roster/latest/Samsara/Roster/Processors/InterfaceInlineProcessor.md
+                            -
+                                TraitInlineProcessor: roster/latest/Samsara/Roster/Processors/TraitInlineProcessor.md
+                            -
+                                MethodArgumentDetailProcessor: roster/latest/Samsara/Roster/Processors/MethodArgumentDetailProcessor.md
+                            -
+                                ClassProcessor: roster/latest/Samsara/Roster/Processors/ClassProcessor.md
+                            -
+                                TemplateProcessor: roster/latest/Samsara/Roster/Processors/TemplateProcessor.md
+                            -
+                                PropertyProcessor: roster/latest/Samsara/Roster/Processors/PropertyProcessor.md
+                            -
+                                MethodArgumentProcessor: roster/latest/Samsara/Roster/Processors/MethodArgumentProcessor.md
+                            -
+                                MethodProcessor: roster/latest/Samsara/Roster/Processors/MethodProcessor.md
+                            -
+                                Base:
+                                    -
+                                        BaseCodeProcessor: roster/latest/Samsara/Roster/Processors/Base/BaseCodeProcessor.md
 theme:
-  name: readthedocs
-  highlightjs: true
-  hljs_languages:
-    - php
+    name: readthedocs
+    highlightjs: true
+    hljs_languages:
+        - php
 markdown_extensions:
-  - toc:
-      toc_depth: 1
-  - admonition
-  - pymdownx.tabbed
-  - pymdownx.superfences
-  - pymdownx.highlight:
-      linenums: true
-      linenums_style: inline
-  - pymdownx.snippets:
-      base_path: ./docs/snippets
-      check_paths: true
-  - pymdownx.extra
+    -
+        toc:
+            toc_depth: 1
+    - admonition
+    - pymdownx.tabbed
+    - pymdownx.superfences
+    -
+        pymdownx.highlight:
+            linenums: true
+            linenums_style: inline
+    -
+        pymdownx.snippets:
+            base_path: ./docs/snippets
+            check_paths: true
+    - pymdownx.extra