使用Shiki-PHP实现代码高亮

使用Shiki-PHP实现代码高亮

项目地址:https://gitcode.com/spatie/shiki-php

在编程世界中，清晰易读的代码是关键，而代码高亮更是提升可读性的利器。今天，我们要介绍一个基于PHP的开源项目——Spatie/shiki-php，它将流行的Shiki语法高亮库引入了PHP环境。

项目介绍

shiki-php 是一个巧妙的工具，能够让你在PHP应用中无缝地集成Shiki的强大功能，提供美观且专业的代码高亮效果。Shiki最初是一个JavaScript库，现在通过这个PHP包装器，你可以在服务器端直接处理和渲染代码片段。

项目技术分析

shiki-php 使用了Shiki的相同语言引擎，确保与许多现代代码编辑器一致的解析能力。它的核心特性包括：

• 支持广泛的语言：除了Shiki本身支持的100多种语言，shiki-php还额外提供了Antlers和Blade两种语言的高亮支持。
• 易于集成：无论是原生PHP项目还是Laravel框架，甚至是league/commonmark的扩展，都可以轻松整合。
• 自定义主题：你可以使用任何兼容VSCode的主题来定制你的代码风格。
• 行标记功能：可以对特定行进行高亮、添加、删除或聚焦标记，方便代码审查和讲解。

项目及技术应用场景

• 博客系统：为源码示例添加专业级别的高亮，提升读者阅读体验。
• 文档平台：在API文档或教程中呈现整洁的代码块。
• 代码分享服务：创建一个简洁明快的代码展示界面。
• 教育软件：用于教学材料的代码高亮，让学生更容易理解。
• 内部开发工具：自动化报告或者日志解析，使代码片段更易读。

项目特点

• 简便的API：只需几行代码就能设置并显示高亮后的代码。
• 性能优秀：在PHP环境中高效工作，无需客户端JavaScript。
• 灵活的主题选择：大量预设主题可供挑选，甚至可以导入自定义主题。
• 多语言支持：内置常用编程语言高亮规则，覆盖广泛。
• 易于扩展：允许自定义语言和插件，适应不断变化的需求。

要开始使用shiki-php，只需运行composer require spatie/shiki-php命令，并确保在项目中安装了shiki的JavaScript包。然后，你就可以像下面这样轻松地高亮代码：

\Spatie\ShikiPhp\Shiki::highlight(
    code: '<?php echo "Hello World"; ?>',
    language: 'php',
    theme: 'github-light',
);

总的来说，shiki-php是一个强大且易用的工具，能够提升你的代码展示质量，使项目更具吸引力。如果你正在寻找一种提升代码可读性的方式，那么不妨试试看shiki-php吧！

项目地址:https://gitcode.com/spatie/shiki-php