obsidian-chord-sheets 的项目扩展与二次开发

项目的基础介绍

obsidian-chord-sheets 是一个开源项目，旨在为音乐创作者和爱好者提供在 Obsidian 文档中创建和显示和弦表的工具。它支持吉他、尤克里里和曼陀林等乐器的和弦图表，并提供了转调、自动滚动等实用功能。该插件能够让用户在编辑和阅读模式下无缝地处理和弦和歌词，极大地提升了音乐创作和学习的体验。

项目的核心功能

• 和弦符号高亮：自动检测并高亮显示和弦符号。
• 和弦图表显示：在鼠标悬停或和弦块上方显示和弦图表，提供多种指法选择。
• 自定义和弦形状：允许用户定义自己的和弦形状。
• 乐器选择：支持多种乐器的和弦图表。
• 无缝编辑：在实时预览/编辑模式下，无需切换到源代码视图即可编辑和弦和歌词。
• 转调功能：一键上下转调。
• 自动滚动：根据用户演奏速度自动滚动歌词。
• 主题颜色支持：插件自动使用 Obsidian 主题颜色。
• 编辑器命令：提供专用的编辑器命令，并支持键盘快捷键。

项目使用了哪些框架或库？

该项目主要使用以下框架和库：

• Vexchords：用于渲染和弦图表。
• tonal：用于解析和弦符号、和弦标准化和转调。
• chords-db：提供尤克里里和吉他的指法数据库。

项目的代码目录及介绍

项目的代码目录结构如下：

• .github/：包含 GitHub 工作流程文件。
• docs/：存放项目文档。
• src/：源代码目录，包括插件的主要逻辑。
• test/：测试代码目录。
• types/：类型定义文件。
• editorconfig/：代码风格配置文件。
• eslintignore：ESLint 忽略配置文件。
• eslintrc：ESLint 配置文件。
• gitignore：Git 忽略配置文件。
• npmrc：npm 配置文件。
• FUNDING.yml：项目资金支持信息。
• LICENSE：项目许可证文件。
• README.md：项目说明文件。
• esbuild.config.mjs：esbuild 配置文件。
• jest.config.js：Jest 测试配置文件。
• manifest.json：插件配置文件。
• package-lock.json：npm 包锁定文件。
• package.json：npm 包配置文件。
• styles.css：样式文件。
• tsconfig.json：TypeScript 配置文件。
• version-bump.mjs：版本更新脚本。
• versions.json：版本信息文件。

对项目进行扩展或者二次开发的方向

• 增加更多乐器支持：根据需求增加其他乐器的和弦图表和指法。
• 优化用户界面：改进和弦图表和编辑界面的用户体验。
• 扩展编辑器命令：添加更多便捷的编辑器命令和键盘快捷键。
• 自定义和弦图表样式：允许用户自定义和弦图表的样式和颜色。
• 增加和弦库：扩展和弦数据库，提供更丰富的和弦选择。
• 多语言支持：增加其他语言的支持，以适应不同国家和地区的用户需求。
• 集成其他音乐工具：与其他音乐创作或学习工具集成，如五线谱显示、节奏训练等。