README

功能

将 Markdown 转换为 HTML。
带有语法高亮的 Markdown 编辑器。
支持 GitHub-Flavored Markdown。
支持外部链接。
使用 PHP CommonMark 解析器。

安装

在您的站点包中运行以下命令

composer require --no-update beromir/neos-markdown

然后在项目根目录中运行 composer update。

配置

您可以在全局范围内启用或禁用以下扩展

Beromir:
    Markdown:
        extensions:
            # GitHub-Flavored Markdown
            gfm: true
            externalLinks: true

用法

独立节点类型

您可以在您的页面上使用独立的 Markdown 节点类型来渲染 Markdown。默认情况下，节点类型包含启用或禁用扩展的选项。Fusion 组件可以在您的站点包中重写。例如，您可以在 HTML 输出中包含一些 CSS 类名。

将 Markdown 编辑器添加到自定义节点类型

该包包含两个混入

编辑器混入
选项混入

将混入添加到您的节点类型

'Vendor.Site:Content.CustomNodeType':
    superTypes:
        'Neos.Neos:Content': true
        'Beromir.Markdown:Mixin.MarkdownEditor': true
        'Beromir.Markdown:Mixin.MarkdownSettings': true

设置混入是可选的。它允许您为节点类型启用或禁用 CommonMark 扩展。如果您不使用混入，则使用全局设置。

您有两种方式在 Fusion 组件中渲染 Markdown。

Fusion 对象

renderer = afx`
<div>
    <Beromir.Markdown:Markdown/>
</div>
`

Eel 辅助工具

html = ${Beromir.Markdown.Markdown.convertMarkdown(props.markdown)}

beromir / neos-markdown

维护者

详细信息

README

功能

安装

配置

用法

独立节点类型

将 Markdown 编辑器添加到自定义节点类型