YiNote 开源项目使用与启动教程
1. 项目介绍
YiNote 是一款基于浏览器的在线视频笔记工具,旨在帮助用户在学习或观看视频时记录和分享想法。这款工具最初于 2016 年作为侧项目开发,并迅速获得了全球用户的喜爱。在疫情期间,开发者对其进行了重写,使其更具可扩展性和可维护性,以满足不同用户的需求,提升学习体验。
YiNote 支持以下功能:
- 在观看在线视频时记录时间戳笔记
- 支持多种视频格式/平台,如 YouTube、嵌入的 YouTube iframe 视频、HTML5 视频、本地浏览器视频等
- 将笔记发送到流行的笔记平台,如 Google Docs、MS OneNote、Evernote
- 支持编辑器中的 Markdown 样式
- 生成带有视频截图的 PDF
- 视频截图注释
- 视频书签和标签
- 通过书签和笔记进行搜索
- 数据的导出和导入
2. 项目快速启动
环境准备
- Node >= 10.0.0
- NPM >= 6.0.0
安装依赖
yarn install
启动开发
运行以下命令启动扩展:
yarn start:ext
对于 content script
的更改,需要在 chrome://extensions
标签页中重新加载扩展。对于 background
和 options
的更改,只需刷新页面即可加载更改。
3. 应用案例和最佳实践
安装扩展
从官方平台商店安装扩展,具体步骤请参考项目文档中的“安装”部分。如果之前使用过 v1.0.0 之前的版本,请查阅“迁移指南”以获取更多信息。
构建并本地安装扩展
你也可以构建扩展,然后本地运行。具体步骤请参考项目文档中的“开发”部分。
使用扩展
YiNote 提供了多种使用方式,例如:
- 直接从网络商店安装
- 构建后在本地安装
开发者贡献
如果你是开发者并希望贡献代码,请阅读项目的“贡献指南”。
国际化
YiNote 目前只支持英文,如果你希望帮助将其翻译成其他语言,请遵循“英文消息 json 文件”中的指示进行翻译。
4. 典型生态项目
YiNote 作为一个开源项目,可以与其他视频平台或工具集成,以提供更丰富的用户体验。以下是一些可能的生态项目:
- 集成新的播放器
- 为网站添加玩家钩子
- 添加消息监听器以响应 YiNote 的视频操作消息
以上是 YiNote 的基本使用和启动教程,希望对您有所帮助。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考