README

This package allows you to easily integrate DropInBlog's rendered content into your Laravel application. It fetches pre-rendered HTML from DropInBlog's API and seamlessly integrates it into your Laravel views.

Requirements

PHP 8.2 or higher
Laravel 11.0 or higher
DropInBlog account with API access

Installation

Install the package via composer:

composer require dropinblog/laravel-rendered

Publish the configuration file:

php artisan vendor:publish --provider="DropInBlog\\Laravel\\Providers\\DropInBlogServiceProvider" --tag="config"

Add your DropInBlog credentials to your .env file:

DROPINBLOG_ID=your-dropinblog-id
DROPINBLOG_API_TOKEN=your-dropinblog-api-token

Configuration

The package publishes a configuration file at config/dropinblog.php with the following options:

return [
    // DropInBlog API Configuration
    'id' => env('DROPINBLOG_ID'),
    'api_token' => env('DROPINBLOG_API_TOKEN'),
    'response_fields' => 'head_html,body_html,head_items',

    // Routes Configuration
    'path' => 'blog',

    // View Configuration
    'layout' => 'layouts.app',
    'sections' => [
        'content' => 'content',
    ],

    // Feed Configuration
    'feed' => [
        'type' => 'rss',
        'limit' => 10,
    ],
];

id: Your DropInBlog ID
api_token: Your DropInBlog API token
path: The base URL path for your blog (defaults to 'blog')
layout: The layout file that your blog views will extend
sections.content: The section name in your layout where blog content will be displayed
feed.type: The default feed type (rss or atom)
feed.limit: The default number of items in feeds

Usage

The package automatically registers routes for your blog at /blog (configurable via the path option). These include:

/blog - Blog index
/blog/page/{page} - Paginated blog index
/blog/{slug} - Individual post
/blog/category/{slug} - Category index
/blog/category/{slug}/page/{page} - Paginated category index
/blog/author/{slug} - Author index
/blog/author/{slug}/page/{page} - Paginated author index
/blog/feed - RSS/Atom feed
/blog/feed/category/{slug} - Category-specific feed
/blog/feed/author/{slug} - Author-specific feed
/blog/sitemap.xml - XML sitemap

Blade Directives

The package provides several Blade directives to help integrate DropInBlog content:

IMPORTANT: Add the @dropInBlogHead directive to your layout's <head> section. This will add title, description, styles and more meta tags inside your <head>.

{{-- Include DropInBlog head content --}}
@dropInBlogHead

{{-- Conditional content only for DropInBlog pages --}}
@isDropInBlog
    This content only shows on blog pages
@endisDropInBlog

{{-- Conditional content only for non-DropInBlog pages --}}
@notDropInBlog
    This content only shows on non-blog pages
@endnotDropInBlog

Avoiding Duplicate Head Elements

The @dropInBlogHead directive adds meta tags title, description, styles and more. Most likely you will already be setting some of these tags in your <head>. You can use directives to prevent any duplicates.

For proper implementation:

Always place the @dropInBlogHead directive in your layout's <head> section
Use the @isDropInBlog and @notDropInBlog directives to conditionally include or exclude your own head elements

Example layout:

<head>
    {{-- Include DropInBlog head content (title, meta tags, etc.) --}}
    @dropInBlogHead

    {{-- Only include your own title on non-blog pages --}}
    @notDropInBlog
        <title>Your Site Title</title>
    @endnotDropInBlog
</head>

This ensures that on blog pages, the title and meta tags come from DropInBlog, while on non-blog pages, your own title and meta tags are used.

Customizing Views

If you want to customize the blog views, you can publish them:

php artisan vendor:publish --provider="DropInBlog\\Laravel\\Providers\\DropInBlogServiceProvider" --tag="views"

The views will be published to resources/views/vendor/dropinblog/.

How It Works

This package fetches pre-rendered HTML from DropInBlog's API and displays it within your Laravel application. The rendered content includes:

bodyHtml: The main content of the page
headHtml: HTML for the <head> section (meta tags, title, etc.)

The package handles all routing and view rendering for you, making it easy to integrate a fully-featured blog into your Laravel application without managing blog content in your database.

License

The MIT License (MIT). Please see License File for more information.

dropinblog/laravel-rendered

包简介

关键字：

README 文档