墨笺 InkNote — Markdown Reader

About

# InkNote — User Manual
Version v2.1.1 | Chrome Extension | https://github.com/gzmliang/mojian-extension

## 1. Overview

InkNote is a lightweight, professional Markdown reader and editor Chrome extension. No registration required. All data stored locally.

**Core Features (36 items):**

File Loading: Open local file / URL / drag-drop / context menu / recent files (20 max)
Rendering: Markdown(GFM) / LaTeX(KaTeX) / Mermaid diagrams / code highlight(190+ lang)
Edit Modes: Read / WYSIWYG / Source (auto-save)
WYSIWYG: Bold/italic/underline/headings/lists/quotes/code / Insert tables/images/links/hr / Undo/redo(50 steps)
TTS: Edge TTS(7 CN/EN/JP voices) / Browser TTS fallback / paragraph reading with highlight
AI Translate: Select text → AI translation / OpenAI-compatible API / configurable endpoint+key
Search: Full-text(case-insensitive) / match highlight / prev-next navigation
Navigation: TOC sidebar(auto-extract headings) / Bookmarks(position+snippet+timestamp) / Highlights(yellow marker)
Themes: Light / Dark / Sepia
Font: 8-36px adjustable
Export: HTML / PDF(print dialog) / Copy Markdown / Export log
Other: Fullscreen / Statistics(chars/paras/code/formulas/images/links/headings) / Debug log panel / Bilingual UI(CN/EN)

## 2. Installation

Search "InkNote" on Chrome Web Store (coming soon), or:
1. Download ZIP from GitHub Releases → extract
2. chrome://extensions → Developer mode → Load unpacked

## 3. Quick Start

**Open documents (5 ways):**
1. Click toolbar icon to open blank page
2. Drag .md/.txt/.html files into window
3. Click "📂 Open File" or welcome screen button
4. Click "🔗 Open from URL" and enter link
5. Right-click .md link or selected text → "Open with InkNote"

**Layout:** Header(file name+buttons) → File info bar(size+stats) → Content area(Read/WYSIWYG/Source) → Floating toolbar(all features) → Debug panel(collapsible)

**Switch modes:** 📖Read(default) / ✏️WYSIWYG(Ctrl+E) / 📝Source. Ctrl+S saves WYSIWYG and returns to Read.

## 4. Rendering

Markdown → marked parse → Mermaid preprocess → KaTeX render → highlight.js highlight → Mermaid render

Inline math `$...$` and display math `$$...$$`. Mermaid: flowchart/sequence/class/state/pie/Gantt.

## 5. TTS

Configure Edge TTS server in Settings→Edge TTS. Voices: Xiaoxiao(F), Yunxi(M), Xiaohan(F-warm), Yunjian(M-mature), Aria(EN-F), Guy(EN-M), Nanami(JP-F). Falls back to browser TTS when unavailable.

## 6. AI Translation

Settings→Translate API: Enter endpoint/key/model. Select text→🌐translate(or floating 🌐). Supports DeepSeek/OpenAI compatible APIs.

## 7. Keyboard Shortcuts

Ctrl+F search / Ctrl+E toggle edit / Ctrl+S save WYSIWYG / Ctrl+B/I/U bold/italic/underline / Ctrl+Z/Shift+Z undo/redo / j↓ page down / k↑ page up / Esc close / ? help

## 8. FAQ

Q: Free? — Yes, completely free, no ads, no IAP
Q: Need internet? — Basic features work offline; translation and TTS need network
Q: Translation requirements? — Bring your own OpenAI-compatible API key; DeepSeek recommended
Q: Data location? — Browser localStorage; uninstalling clears data
Q: Supported formats? — .md/.markdown/.txt/.html/.htm
Q: PDF only one page? — Update to v2.1.1+; old bug fixed
Q: Report issues? — github.com/gzmliang/mojian-extension/issues

## 9. Permissions & Privacy

Permission: contextMenus only (right-click menu). No network/tab/history permissions. No data collection. Translation and TTS requests go directly to user-configured servers.

# 墨笺 InkNote 使用说明书
版本 v2.1.1 | Chrome 浏览器扩展 | https://github.com/gzmliang/mojian-extension

## 一、产品概述

墨笺 InkNote 是一款轻量专业的 Markdown 阅读与编辑 Chrome 扩展。无需注册，数据本地存储。

**核心功能（36项）：**

文档加载：本地文件打开 / URL加载 / 拖拽 / 右键菜单 / 最近文件（20个）
渲染引擎：Markdown(GFM) / LaTeX公式(KaTeX) / Mermaid图表 / 代码高亮(190+语言)
编辑模式：阅读模式 / WYSIWYG所见即所得 / 源码编辑(自动保存)
WYSIWYG：粗斜体/下划线/标题/列表/引用/代码块 / 插入表格/图片/链接/分隔线 / 撤销/重做(50步)
朗读TTS：Edge TTS(7种中英日语) / 浏览器TTS备用 / 逐段朗读+高亮跟随
AI翻译：选中文本→调用AI API翻译 / 支持OpenAI兼容接口 / 自由配置端点+Key
搜索：全文搜索(不区分大小写) / 匹配高亮 / 前后跳转
导航：大纲侧栏(TOC自动提取标题) / 书签(位置+片段+时间戳) / 高亮(黄色标记)
主题：明亮 / 深色 / 羊皮纸
字体：8-36px自由调节
导出：HTML / PDF(浏览器打印) / Markdown复制 / 日志导出
其他：全屏 / 文档统计(字数/段落/代码块/公式/图片/链接/标题) / 调试日志面板 / 中英双语界面

## 二、安装

从 Chrome Web Store 搜索"墨笺 InkNote"安装（即将上架），或：
1. 从 GitHub Releases 下载 ZIP → 解压
2. chrome://extensions → 开发者模式 → 加载已解压的扩展

## 三、快速使用

**打开文档（5种方式）：**
1. 点击工具栏图标打开空白页
2. 拖拽 .md/.txt/.html 文件到窗口
3. 点击"📂 打开文件"或欢迎页按钮
4. 点击"🔗 从 URL 打开"输入链接
5. 右键 .md 链接或选中文本 → "用墨笺打开"

**界面布局：** 顶栏(文件名+操作按钮) → 文件信息栏(大小+字数统计) → 内容区(阅读/WYSIWYG/源码) → 浮动工具栏(所有功能按钮) → 调试面板(可折叠)

**编辑模式切换：** 📖阅读(默认) / ✏️WYSIWYG(Ctrl+E切换) / 📝源码。Ctrl+S保存WYSIWYG返回阅读模式。

## 四、渲染说明

Markdown 源码 → marked解析 → Mermaid预处理 → KaTeX公式渲染 → highlight.js代码高亮 → Mermaid图表渲染

支持行内公式 `$...$` 和块级公式 `$$...$$`。Mermaid支持流程图/时序图/类图/状态图/饼图/甘特图。

## 五、TTS朗读

需要配置 Edge TTS 服务器地址（设置→Edge TTS）。支持语音：Xiaoxiao(女)、Yunxi(男)、Xiaohan(女-温暖)、Yunjian(男-成熟)、Aria(英女)、Guy(英男)、Nanami(日女)。服务不可用时自动回退浏览器TTS。

## 六、AI翻译

设置→翻译API：填入端点/Key/模型。选中文本→🌐翻译（或浮动菜单🌐）。支持DeepSeek/OpenAI等兼容接口。

## 七、键盘快捷键

Ctrl+F搜索 / Ctrl+E切换编辑 / Ctrl+S保存WYSIWYG / Ctrl+B/I/U粗斜下 / Ctrl+Z/Shift+Z撤销重做 / j↓向下翻页 / k↑向上翻页 / Esc关闭 / ?快捷键帮助

## 八、常见问题

Q: 免费吗？— 完全免费，无广告无内购
Q: 需要联网？— 基本功能离线可用，翻译和TTS需联网
Q: 翻译需要什么？— 自备OpenAI兼容API Key，推荐DeepSeek
Q: 数据存在哪？— 浏览器localStorage，卸载会清除
Q: 支持什么格式？— .md/.markdown/.txt/.html/.htm
Q: PDF只出一页？— 更新到v2.1.1+，旧版bug已修复
Q: 提交问题？— github.com/gzmliang/mojian-extension/issues

## 九、权限与隐私

权限：仅 contextMenus（右键菜单）。不请求网络/标签页/浏览历史权限。不收集任何数据。翻译和TTS请求直达用户配置的服务器。