README

Parsedown Extended

探索文档

报告错误 · 请求功能 · 讨论

目录

• 简介
• 功能
• 入门
• 错误和功能请求
• 贡献
• 社区
• 版权和许可

简介

ParsedownExtended是Parsedown的扩展，提供额外的功能和功能。它旨在提供一个易于使用的Markdown解析解决方案，同时扩展基础Parsedown库的功能。

扩展功能的独立版本也作为单独的库提供

• Parsedown Toc
• Parsedown Math

功能

ParsedownExtended包含各种功能，以增强您的Markdown解析体验

• 任务列表：在Markdown中创建简单的任务列表。
• Smartypants：自动将直引号转换为曲线引号，将破折号转换为长破折号和短破折号等。
• 表情符号：支持渲染表情符号。
• 标题永久链接：为您的标题生成永久链接。
• 目录：根据标题自动生成目录。
• 键盘快捷键：渲染键盘快捷键组合。
• 标记：在您的文档中标记文本以强调或区分。
• 上标和下标：将文本渲染为上标或下标。
• 图表语法支持：识别图表语法，以便与mermaid.js和chart.js等库集成。
• LaTeX语法支持：检测LaTeX语法，适用于数学表达式，并使用KaTeX.js等库进行渲染。
• 预定义缩写：轻松定义和使用缩写。
• GFM警报：使用GitHub Flavored Markdown警报语法创建警报，可以定制为您自己的语言。
• 可定制选项：为每个Markdown元素提供广泛的定制选项。
• 附加功能：ParsedownExtended持续发展，随着时间的推移添加更多功能。

入门

手册

从最新版本下载源代码 您必须包含 parsedown.php 1.7+ 包含 ParsedownExtended.php

require 'Parsedown.php';
require 'ParsedownExtra.php'; // optional
require 'ParsedownExtended.php';

$ParsedownExtended = new ParsedownExtended();

echo $ParsedownExtended->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
// you can also parse inline markdown only
echo $ParsedownExtended->line('Hello _Parsedown_!'); # prints: Hello <em>Parsedown</em>!

使用composer

在命令行界面中，导航到您的项目文件夹，然后运行此命令

composer require benjaminhoegh/parsedown-extended

然后需要自动加载文件

require 'vendor/autoload.php';

$ParsedownExtended = new ParsedownExtended();

echo $ParsedownExtended->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
// you can also parse inline markdown only
echo $ParsedownExtended->line('Hello _Parsedown_!'); # prints: Hello <em>Parsedown</em>!

错误和功能请求

有错误或功能请求吗？请首先阅读问题指南并搜索现有和已关闭的问题。如果您的問題或想法尚未得到解决，请打开新问题。

贡献

请阅读我们的贡献指南。其中包括打开问题的说明、编码标准和开发注意事项。

所有PHP代码应遵循代码规范。

社区

获取ParsedownExtended的开发更新，并与项目负责人和社区成员进行交流。

• 加入GitHub讨论。

版权和许可

代码和文档版权属于2024年的ParsedownExtended作者。代码在MIT许可证下发布。文档在Creative Commons下发布。