ohseesoftware/oh-see-gists

Statamic v3 扩展，用于使用 GitHub 的 Gists 来托管代码块。

维护者

详细信息

github.com/ohseesoftware/oh-see-gists

源代码

问题

安装: 320

依赖项: 0

建议者: 0

安全: 0

星级: 4

关注者: 2

分支: 3

开放问题: 2

类型:statamic-addon

v3.2.0 2021-06-16 14:15 UTC

Requires

Requires (Dev)

MIT 8eba9993fbe1c0839f924fea91f7f46fbdfed38f

This package is auto-updated.

Last update: 2024-09-10 19:07:05 UTC

README

Current Release Build Status Badge Coverage Status Maintainability Score Downloads MIT License

使用 GitHub Gists 在您的网站上嵌入代码片段。例如：https://ohseemedia.com/posts/hooks-can-only-be-called-inside-the-body-of-a-function-component-reactjs-error/

安装

安装扩展

composer require ohseesoftware/oh-see-gists

发布扩展的资产

php artisan vendor:publish --tag=oh-see-gists

这将发布

  • GitHub API 的配置文件
  • resources/views 目录中的视图
  • resources/fieldsets 目录中的字段集

用法

将您的 GitHub token 添加到 .env 文件

您需要创建一个新的个人访问令牌。您可以在以下位置完成此操作：https://github.com/settings/tokens/new。

令牌只需要 gist 权限。

将令牌添加到 .env 文件中的 OH_SEE_GISTS_GITHUB_TOKEN。

将字段集添加到您的蓝图（s）

将发布的字段集名为 gist_block。您需要更新您的蓝图，以便在需要使用字段集的地方引用该字段集。以下是在 bard 中的一个示例

type: bard
sets:
  gist_content:
    display: Gist
    fields:
      - import: gist_block

命名

您必须遵循两个 非常重要 的命名约定

  • 字段集的 gist_content 名称非常重要。扩展引用此键，因此您不能更改它。
  • 您的 bard 块必须命名为 content，以便扩展可以将其保存到您的 GitHub Gists。否则，您只是在 Statamic 网站上创建代码块。

在模板中使用部分

扩展为您发布了一个部分，您可以在模板中使用它来渲染 Gists。您可以使用它如下所示

{{ bard_content }}
    {{ if type == "gist_content" }}
        {{ partial src="partials/gist_content" }}
    {{ /if }}
{{ /bard_content }}