aleksnyder/grav-plugin-prism

使用Prism语法高亮嵌入代码块

安装: 4

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

类型:grav-plugin

0.0.1 2019-05-12 01:29 UTC

This package is auto-updated.

Last update: 2024-09-13 11:26:36 UTC


README

应修改此README.md文件以描述该插件的功能、安装、配置和通用用法。

Prism 插件是为 Grav CMS 使用的。它提供了一种将 prism 语法高亮库嵌入 markdown 的方法。

安装

安装 Prism 插件有两种方式。GPM(Grav 包管理器)安装方法允许您通过简单的终端命令快速轻松地安装插件,而手动方法允许您通过 zip 文件进行安装。

GPM 安装(推荐)

安装此插件最简单的方式是通过您的系统终端(也称为命令行)中的 Grav 包管理器(GPM)。在您的 Grav 安装根目录下输入

bin/gpm install prism

这将安装 Prism 插件到您的 Grav /user/plugins 目录中。其文件位于 /your/site/grav/user/plugins/prism 下。

手动安装

要安装此插件,只需下载此仓库的 zip 版本,并将其解压到 /your/site/grav/user/plugins 下。然后,将文件夹重命名为 prism。您可以在 GitHub 或通过 GetGrav.org 找到这些文件。

现在您应该在以下位置找到所有插件文件

/your/site/grav/user/plugins/prism

注意:此插件是 Grav 的模块化组件,需要 Grav 以及 ErrorProblems 插件才能运行。

配置

在配置此插件之前,您应将 user/plugins/prism/prism.yaml 复制到 user/config/plugins/prism.yaml,并只编辑该副本。

以下是默认配置和可用选项的解释

enabled: true

使用方法

描述如何使用插件。

致谢

您是否集成了第三方代码?想要感谢某人吗?

待办事项

  • 如果有,请说明未来的计划。