Frogmouth：终端中的Markdown浏览利器

💡 功能解析
Frogmouth作为一款终端Markdown浏览器，核心价值在于打破传统GUI工具的局限，让开发者无需离开命令行即可高效处理Markdown内容。其三大应用场景覆盖日常开发全流程：

1.1 本地文档即时预览

告别频繁切换编辑器与浏览器的低效 workflow，通过终端直接渲染本地Markdown文件。支持标题导航、代码块高亮和链接跳转，配合快捷键⌨️ Ctrl+R 实时刷新内容，特别适合README文档撰写与本地知识库管理。

1.2 远程仓库文档快速访问

集成GitHub、GitLab等代码托管平台API，通过命令快速加载远程仓库中的Markdown文件。例如输入 /github Textualize/frogmouth README.md 即可直接查看目标仓库文档，省去克隆仓库的繁琐步骤。

1.3 终端环境知识管理

内置书签管理与浏览历史功能，可将常用文档路径或URL添加至收藏夹，通过 bookmark add 命令快速保存当前位置。配合目录导航侧边栏，实现终端内的轻量级知识图谱构建。

💡 环境准备
Frogmouth采用Python开发，通过Poetry管理依赖，兼容主流操作系统与Python版本：

系统环境	最低版本要求	推荐配置
Python	3.8	3.10+
Linux	内核4.15+	Ubuntu 20.04+
macOS	10.15	12.0+
Windows	WSL2	WSL2+Ubuntu
终端模拟器	UTF-8支持	Alacritty/Kitty

⌨️ 安装命令：

git clone https://gitcode.com/gh_mirrors/fr/frogmouth
cd frogmouth && poetry install --without dev

💡 快速上手
从启动到熟练操作仅需三个步骤，轻松告别"配置地狱"：

3.1 基础启动

poetry run frogmouth [文件路径/URL]

示例：poetry run frogmouth README.md 或 poetry run frogmouth https://example.com/docs.md

3.2 核心操作

• 导航面板切换：Tab 键循环切换目录/文件列表/书签/历史
• 内容跳转：Ctrl+G 输入标题ID快速定位
• 主题切换：F1 键切换明/暗模式

3.3 常见问题解决

• 路径解析错误 → 检查文件权限或使用绝对路径
• 渲染乱码 → 确保终端支持TrueColor（可通过 tput colors 验证）
• 依赖冲突 → 使用 poetry env use python3.10 指定Python版本

💡 核心配置
配置文件位于 ~/.config/frogmouth/config.yml，采用YAML格式管理应用行为：

4.1 显示配置

参数名	默认值	允许范围	实战建议
line_numbers	false	true/false	阅读代码文档时设为true
tab_width	4	2-8	与项目代码风格保持一致
theme	auto	light/dark/auto	终端支持动态主题时使用auto

4.2 网络配置

参数名	默认值	允许范围	实战建议
timeout	10	5-30	网络不稳定时适当增大
proxy	none	http://URL	企业内网环境需配置代理

生产环境最佳实践：设置 cache_dir: /tmp/frogmouth 避免重复下载；配置 max_history: 100 限制历史记录条数

💡 进阶指南
掌握以下技巧，解锁终端文档处理新姿势：

5.1 命令系统

通过Omnibox（Ctrl+O唤起）执行高级操作：

• /gh owner/repo [file]：快速加载GitHub仓库文档
• /bookmark add "标题"：将当前位置添加到书签
• /chdir ~/docs：切换本地文件浏览根目录

5.2 自定义快捷键

修改配置文件 keybindings 节点：

keybindings:
  reload: "Ctrl+R"
  bookmark: "Ctrl+B"

参见→3.2节基础操作

5.3 插件扩展

通过 plugins 目录添加自定义功能，例如：

• 代码块复制功能：plugins/copy_code/
• 数学公式渲染：plugins/mathjax/

Frogmouth将终端的高效与Markdown的优雅完美结合，无论是日常文档阅读还是开发笔记管理，都能成为开发者的得力助手。更多高级用法请参考项目内置帮助文档（F1键唤起）。