Obsidian Better CodeBlock插件:打造专业级代码展示体验
【免费下载链接】obsidian-better-codeblockAdd title, line number to Obsidian code block项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-better-codeblock
Obsidian Better CodeBlock是一款专为Obsidian笔记应用设计的代码块增强插件,能够显著提升技术笔记中代码展示的专业性和可读性。通过添加标题、行号和高亮等功能,让代码块不再单调乏味。
核心功能特性
智能标题添加
使用TI:"你的标题"语法为代码块添加清晰标识,便于代码分类和管理。每个代码块都可以拥有专属标题,让技术文档更加条理清晰。
代码行高亮功能
通过HL:"行数"语法标记关键代码行,支持多种高亮模式:
- 单行高亮:
HL:"5" - 多行高亮:
HL:"1,3,5" - 范围高亮:
HL:"1-3"
灵活折叠管理
添加"FOLD"参数设置代码块的默认折叠状态,特别适合处理大型代码块。点击标题即可展开或折叠代码内容,保持笔记界面整洁。
Better CodeBlock折叠功能演示,展示代码块标题与折叠效果
安装与配置
手动安装步骤
- 从项目仓库下载
main.js、styles.css和manifest.json三个核心文件 - 在Obsidian库中创建插件目录:
VaultFolder/.obsidian/plugins/obsidian-better-codeblock/ - 将下载的文件复制到该目录
- 重启Obsidian并在插件设置中启用"Better CodeBlock"
语法使用示例
// TI:"用户认证模块" HL:"3,5-7" "FOLD" function authUser(username, password) { if (!username || !password) { throw new Error("用户名和密码不能为空"); } const hashedPwd = hash(password); const user = db.query(`SELECT * FROM users WHERE name = ?`, [username]); return user && user.pwd === hashedPwd; }版本功能演进
v1.0.5版本改进
- 新增语法组合功能,支持同时设置标题、高亮和折叠
- 优化代码高亮算法,提升渲染性能
v1.0.4版本特性
- 在代码块右上角添加语言标识,清晰显示代码类型
- 修复折叠状态记忆问题,提升用户体验
Better CodeBlock完整功能展示,包含标题、语言标识和高亮效果
实用场景应用
技术文档编写
在API文档、开发指南中使用Better CodeBlock,能够为代码示例添加专业标题和高亮效果,显著提升文档质量。
学习笔记整理
在教学笔记中运用折叠和高亮功能,突出重点知识点,便于复习和回顾。
项目代码展示
在项目说明文档中展示关键代码片段,通过标题和行号让代码结构更加清晰。
常见问题处理
代码自动换行异常
有时会出现自动换行错误,可以通过切换预览模式来解决此问题。
PDF导出限制
目前PDF导出暂不支持自动换行功能,建议在导出前调整代码块宽度以确保格式正常。
使用技巧与建议
语法组合优化
合理组合不同语法参数,实现更丰富的代码展示效果。例如同时使用标题、高亮和折叠功能,打造专业的代码演示。
个性化配置
根据个人使用习惯调整插件设置,创建符合自己需求的代码展示风格。
Better CodeBlock插件通过简单直观的语法,为Obsidian用户提供了强大的代码美化功能。无论是日常技术笔记、项目文档还是学习资料,都能通过这款插件提升代码展示的专业水准。立即开始使用,让你的技术笔记焕然一新。
【免费下载链接】obsidian-better-codeblockAdd title, line number to Obsidian code block项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-better-codeblock
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考