Entities can now be exported as markdown

owlchester · Mar 4, 2024 · a455bec · a455bec
1 parent d00d28c
commit a455bec
Show file tree

Hide file tree

Showing 7 changed files with 149 additions and 1 deletion.
diff --git a/app/Http/Controllers/Entity/ExportController.php b/app/Http/Controllers/Entity/ExportController.php
@@ -7,6 +7,7 @@
 use App\Models\Entity;
 use App\Services\Entity\ExportService;
 use App\Traits\GuestAuthTrait;
+use Illuminate\Support\Str;
 
 /**
  * Class ExportController
@@ -30,6 +31,15 @@ public function json(Campaign $campaign, Entity $entity)
         return $this->service->entity($entity)->json();
     }
 
+    public function markdown(Campaign $campaign, Entity $entity)
+    {
+        $this->authEntityView($entity);
+
+        return response()->view('entities.pages.print.markdown', ['entity' => $entity, 'model' => $entity->child])
+            ->header('Content-Type', 'application/md')
+            ->header('Content-disposition','attachment; filename="' . Str::slug($entity->name) . '.md"');
+        }
+
     public function html(Campaign $campaign, Entity $entity)
     {
         $this->authEntityView($entity);

diff --git a/composer.json b/composer.json
@@ -31,6 +31,7 @@
         "laravel/ui": "^4.2.1",
         "laravelcollective/html": "^6.0",
         "league/flysystem-aws-s3-v3": "^3.5",
+        "league/html-to-markdown": "^5.1",
         "livewire/livewire": "^3.3",
         "mailerlite/mailerlite-php": "^1.0",
         "mcamara/laravel-localization": "^1.7",

diff --git a/composer.lock b/composer.lock
diff --git a/lang/en/crud.php b/lang/en/crud.php
@@ -17,6 +17,7 @@
         'go_to'             => 'Go to :name',
         'help'              => 'Help',
         'json-export'       => 'Export (JSON)',
+        'markdown-export'   => 'Export (Markdown)',
         'manage_links'      => 'Manage Links',
         'move'              => 'Move',
         'new'               => 'New',

diff --git a/resources/views/entities/components/header.blade.php b/resources/views/entities/components/header.blade.php
@@ -222,6 +222,10 @@
                             <x-icon class="fa-solid fa-download"></x-icon>
                             {{ __('crud.actions.json-export') }}
                         </x-dropdowns.item>
+                        <x-dropdowns.item link="{{ route('entities.markdown.export', [$campaign, $entity]) }}">
+                            <x-icon class="fa-solid fa-download"></x-icon>
+                            {{ __('crud.actions.markdown-export') }}
+                        </x-dropdowns.item>
                     @endif
                     @if ((empty($disableCopyCampaign) || !$disableCopyCampaign) && auth()->check() && auth()->user()->hasOtherCampaigns($model->campaign_id))
                         <hr class="m-0" />

diff --git a/resources/views/entities/pages/print/markdown.blade.php b/resources/views/entities/pages/print/markdown.blade.php
@@ -0,0 +1,42 @@
+<?php /**
+ * @var \App\Models\MiscModel $model
+ * @var \App\Models\Entity $entity
+ */
+use Illuminate\Support\Str;
+$converter = new League\HTMLToMarkdown\HtmlConverter();
+$converter->getConfig()->setOption('strip_tags', true);
+$converter->getEnvironment()->addConverter(new League\HTMLToMarkdown\Converter\TableConverter());
+?>
+<head>
+  <title>{!! Str::slug($entity->name) !!}</title>
+</head>
+
+# {!! $entity->name !!}
+
+@if ($model instanceof \App\Models\Character && $model->isDead())
+    {{ __('characters.hints.is_dead') }}
+@endif
+@if ($model instanceof \App\Models\Quest && $model->isCompleted())
+    {{ __('quests.fields.is_completed') }}
+@endif
+@if ($model instanceof \App\Models\Organisation && $model->isDefunct())
+    {{ __('organisations.hints.is_defunct') }}
+@endif
+@if ($model instanceof \App\Models\Creature && $model->isExtinct())
+    {{ __('creatures.hints.is_extinct') }}
+@endif
+
+@if ($model instanceof \App\Models\Character && !empty($model->title))
+    {{ $model->title }}
+@endif
+
+@if (!empty($model->type))
+    {{ $model->type }}
+@endif
+
+{!! $converter->convert($model->entry) !!}            
+
+@foreach ($entity->posts as $post)
+   # {!! $post->name !!}
+   {!! $converter->convert($post->entry) !!}
+@endforeach
diff --git a/routes/campaigns/entities.php b/routes/campaigns/entities.php
@@ -286,6 +286,7 @@
 // Export
 Route::get('/w/{campaign}/entities/{entity}/html-export', 'Entity\ExportController@html')->name('entities.html-export');
 Route::get('/w/{campaign}/entities/{entity}.json', 'Entity\ExportController@json')->name('entities.json.export');
+Route::get('/w/{campaign}/entities/{entity}.md', 'Entity\ExportController@markdown')->name('entities.markdown.export');
 
 
 Route::get('/w/{campaign}/entities/{entity}/template', 'Entity\TemplateController@update')->name('entities.template');