Obsidian 插件:GitHub README

Obsidian 插件:GitHub README

插件名片

  • 插件名称:GitHub README
  • 插件作者:Hakem
  • 插件说明:Edit and publish GitHub README files directly from Obsidian. - This plugin has not been manually reviewed by Obsidian staff.
  • 插件分类:[‘第三方工具集成’, ‘编辑工具’, ‘发布工具’, ‘obsidian插件’]
  • 项目地址:点我访问
  • 国内下载地址:下载安装
  • 自述文件:Readme

概述

主要功能 该插件允许用户在 Obsidian 中直接浏览 GitHub 仓库,编辑 README 文件,实时预览渲染效果,并一键提交更新回 GitHub,无需切换至浏览器或外部编辑器。

适用场景 适用于开发者、技术写作者及内容创作者,特别是那些需要并行处理代码仓库、技术文档和个人笔记,希望将文档工作流无缝整合进 Obsidian 知识库的用户。

核心特色

  1. 无缝集成:支持在 Obsidian 内发现仓库、编辑 Markdown 并实时预览,支持编辑、预览及分屏模式。
  2. 灵活交互:具备可折叠侧边栏、可拖拽分屏分隔线及可选行号显示,优化专注写作体验。
  3. 本地同步:支持将 README 同步至本地 Vault,便于在笔记中引用和参考。
  4. 全平台支持:兼容桌面端和移动端 Obsidian。

使用建议

  1. 在插件设置中配置 GitHub Token 以完成身份验证。
  2. 通过侧边栏选择目标仓库并打开 README。
  3. 利用分屏模式对照编辑与预览,确保格式正确。
  4. 编辑完成后,输入自定义 Commit Message 并保存至 GitHub。
  5. 建议保留本地同步副本,以便在离线或笔记上下文中快速查阅。
Help

这篇插件文章还没有人贡献,欢迎占坑!
如果您有好的想法欢迎提交PR或者文末留言。




反馈交流

其他渠道

版权声明