Add support for appending/prepending markdown content (closes #262)

Author: shalvah

README.md

@@ -240,6 +240,13 @@ $ php artisan api:update
 
 As an optional parameter, you can use `--location` to tell the update command where your documentation can be found.
 
+## Automatically add markdown to the beginning or end of the documentation
+ If you wish to automatically add the same content to the docs every time you generate, you can add a `prepend.md` and/or `append.md` file to the source folder, and they will be included above and below the generated documentation.
+ 
+ **File locations:**
+- `public/docs/source/prepend.md`
+- `public/docs/source/append.md`
+
 ## Skip single routes
 
 If you want to skip a single route from a list of routes that match a given prefix, you can use the `@hideFromAPIDocumentation` tag on the Controller method you do not want to document.

src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php

@@ -111,6 +111,8 @@ private function writeMarkdown($parsedRoutes)
         $outputPath = $this->option('output');
         $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md';
         $compareFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'.compare.md';
+        $prependFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'prepend.md';
+        $appendFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'append.md';
 
         $infoText = view('apidoc::partials.info')
             ->with('outputPath', ltrim($outputPath, 'public/'))
@@ -156,12 +158,19 @@ private function writeMarkdown($parsedRoutes)
             });
         }
 
+        $prependFileContents = file_exists($prependFile)
+            ?file_get_contents($prependFile)."\n" : '';
+        $appendFileContents = file_exists($appendFile)
+            ? "\n".file_get_contents($appendFile) : '';
+
         $documentarian = new Documentarian();
 
         $markdown = view('apidoc::documentarian')
             ->with('writeCompareFile', false)
             ->with('frontmatter', $frontmatter)
             ->with('infoText', $infoText)
+            ->with('prependMd', $prependFileContents)
+            ->with('appendMd', $appendFileContents)
             ->with('outputPath', $this->option('output'))
             ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'))
             ->with('parsedRoutes', $parsedRouteOutput);
@@ -178,6 +187,8 @@ private function writeMarkdown($parsedRoutes)
             ->with('writeCompareFile', true)
             ->with('frontmatter', $frontmatter)
             ->with('infoText', $infoText)
+            ->with('prependMd', $prependFileContents)
+            ->with('appendMd', $appendFileContents)
             ->with('outputPath', $this->option('output'))
             ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'))
             ->with('parsedRoutes', $parsedRouteOutput);

src/resources/views/documentarian.blade.php

@@ -4,16 +4,16 @@
 <!-- START_INFO -->
 {!! $infoText !!}
 <!-- END_INFO -->
-
+{!! $prependMd !!}
 @foreach($parsedRoutes as $group => $routes)
 @if($group)
 #{!! $group !!}
 @endif
 @foreach($routes as $parsedRoute)
 @if($writeCompareFile === true)
-{!! $parsedRoute['output']!!}
+{!! $parsedRoute['output'] !!}
 @else
-{!! isset($parsedRoute['modified_output']) ? $parsedRoute['modified_output'] : $parsedRoute['output']!!}
+{!! isset($parsedRoute['modified_output']) ? $parsedRoute['modified_output'] : $parsedRoute['output'] !!}
 @endif
 @endforeach
-@endforeach
+@endforeach{!! $appendMd !!}

tests/Fixtures/index.md

@@ -106,3 +106,4 @@ $.ajax(settings).done(function (response) {
 
 <!-- END_960a1b2b0f0f4dde8ce993307397f9c4 -->
 
+

tests/Fixtures/resource_index.md

@@ -282,3 +282,4 @@ $.ajax(settings).done(function (response) {
 
 <!-- END_4bb7fb4a7501d3cb1ed21acfc3b205a9 -->
 
+

tests/GenerateDocumentationTest.php

@@ -123,8 +123,8 @@ public function testCanParseResourceRoutes()
             '--routePrefix' => 'api/*',
         ]);
         $fixtureMarkdown = __DIR__.'/Fixtures/resource_index.md';
-        $gneratedMarkdown = __DIR__.'/../public/docs/source/index.md';
-        $this->assertFilesHaveSameContent($fixtureMarkdown, $gneratedMarkdown);
+        $generatedMarkdown = __DIR__.'/../public/docs/source/index.md';
+        $this->assertFilesHaveSameContent($fixtureMarkdown, $generatedMarkdown);
     }
 
     public function testGeneratedMarkdownFileIsCorrect()