README

此Laravel包允许您轻松地为您的应用程序或网站创建Open Graph图像。如果您正在寻找后端仓库，请点击此处。

支持我们

喜欢我们的工作？您可以通过赞助或购买我们的产品和服务来支持我们。

安装

您可以通过composer安装此包

composer require flowframe/og-image-client

您可以轻松发布配置，如下所示

php artisan og-image-client:install

使用方法

一旦您设置好服务器，您就可以开始使用客户端包。

首先，设置您的.env

OG_IMAGE_URL=<your_server_url> // https://your-app-on.vercel.com/api

OG_IMAGE_TEMPLATE_PATH=<your_template_path> // default _og-image, we recommend to keep this

OG_IMAGE_SECRET_TOKEN=<your_secret_token_from_server>

别忘了添加/api后缀。

然后生成您的图像

// helper function, you can also use the Facade: `OgImageClient::generate(...)`
$image = og()->generate([
    'template' => '_og-images/example', // resources/views/_og-images/example.blade.php

    // Attributes which will be used in the template view
    'title' => 'Hello Flowframe',
    'subtitle' => 'How are you doing?',

    // Array are also supported
    'options' => [
        'Wow',
        'Much',
        'Cool',
    ],
]);

在本地开发时，您也可以通过以下方式预览您的图像

return og()->preview([
    'template' => '_og-images/example',
    'title' => 'Hello Flowframe',
    'subtitle' => 'How are you doing?',
    'options' => [
        'Wow',
        'Much',
        'Cool',
    ],
]);

这将使用数据渲染模板。

模板

模板由网站本身提供。或者，您也可以在负载中覆盖URL以指向另一个网站。

您可以在任何位置放置模板，我们建议将其放置在resources/views/_og-images中。

以下是一个模板示例

<!-- HTML scaffolding... -->

<body>
    <div>
        <h1>{{ $payload['title] }}</h1>

        <p>{{ $payload['subtitle] }}</p>

        <ul>
            @foreach($payload['options'] as $option)
                <li>{{ $option }}</li>
            @endforeach
        </ul>
    </div>
</body>

请注意，可空值可能会引发错误。您可以通过创建需要您实现某些字段或简单地执行的操作来轻松避免它：{{ $payload['title] ?? '' }}。

flowframe / og-image-client

维护者

详细信息

README

支持我们

安装

使用方法

模板

安全漏洞

致谢

许可