pi-md-friendly
Pi extension: clean and enhanced Markdown rendering in terminal (H3~H6 visual hierarchy, fence preservation, formatting optimization).
Package details
Install pi-md-friendly from npm and Pi will load the resources declared by the package manifest.
$ pi install npm:pi-md-friendly- Package
pi-md-friendly- Version
0.1.1- Published
- Aug 22, 2026
- Downloads
- 384/mo · 28/wk
- Author
- huimingsong
- License
- MIT
- Types
- extension
- Size
- 6.2 KB
- Dependencies
- 0 dependencies · 2 peers
Pi manifest JSON
{
"extensions": [
"./index.ts"
]
}Security note
Pi packages can execute code and influence agent behavior. Review the source before installing third-party packages.
README
pi-md-friendly
pi-md-friendly 是一个专为 pi coding agent 设计的终端 Markdown 视觉优化扩展。
在终端环境中,深层标题(###、####、#####)往往无法被终端渲染器很好地区分层级,甚至会残留字面的 ### 符号,破坏阅读体验。pi-md-friendly 通过轻量级的纯显示层转换,重塑视觉层次,让终端中的 Markdown 排版清晰优雅。
特性 (Features)
- 层次重塑 (Hierarchy Mapping):
# H1:保持原生主标题(强调色 + 加粗 + 下划线)。## H2:保持原生二级标题(强调色 + 加粗)。### H3:映射为◆ 标题内容(加粗并附带专属菱形前缀,层次分明)。#### H4:映射为· 标题内容(加粗圆点子标题)。##### H5 / H6:映射为· 标题内容(斜体补充说明)。
- 代码块绝对免疫 (Code Fence Immunity):无论是 ``` 还是 ~~~ 代码块,内部的注释(如
# comment)或代码示例绝对不会被误伤。 - 纯显示层处理 (Pure Display Layer):仅作用于终端渲染输出,绝不修改会话历史或 LLM 上下文。
- 零运行时依赖 (Zero Dependencies):极简实现,基于 Node.js 原生逻辑,秒级加载。
📦 安装 (Installation)
要求:pi >= 0.8.4。
方式 1:通过 npm 安装(推荐)
pi install npm:pi-md-friendly
方式 2:直接通过 GitHub 安装(无需 npm)
pi install git:github.com/songhuiming2007-coder/pi-md-friendly
方式 3:本地开发测试
克隆本仓库到本地后,在 ~/.pi/agent/settings.json 的 extensions 列表中添加本仓库的 index.ts 绝对路径即可:
{
"extensions": [
"/Users/songguiming/Documents/code/pi-md-friendly/index.ts"
]
}
🧪 验证与测试 (Testing)
运行内置测试用例验证转换与代码块隔离机制:
node test-transform.mjs