User Guide

Get up and running in three steps.

1
Login with GitHub — OAuth or Personal Access Token
2
Clone a repository — tap any repo to download it locally
3
Open a Markdown file — tap to edit, dismiss keyboard to save

使用教程

三步开始使用。

1
用 GitHub 账号登录 — OAuth 授权或个人访问令牌（PAT）
2
克隆一个仓库 — 点击任意仓库将文件下载到本地
3
打开 Markdown 文件 — 点击进入编辑，收起键盘即保存

Login

Two ways to authenticate with GitHub:

OAuth Login Recommended

Authorize through Safari — no token creation needed.

  1. Open the app and tap Login with GitHub
  2. Safari opens GitHub's authorization page
  3. Sign in and tap Authorize
  4. You're returned to the app automatically
Required permissions: repo (read/write repositories), user (profile info), gist (share as Gist). If you logged in before the Share as Gist feature existed, sign out and log in again to grant the gist scope.

PAT Login (Personal Access Token)

For users who prefer manual token management.

  1. On GitHub: Settings → Developer settings → Personal access tokens → Tokens (classic)
  2. Generate a new token with repo, gist, and read:user scopes
  3. Copy the token (it won't be shown again)
  4. In the app: tap Login with PAT and paste the token
Tokens are stored encrypted in iOS Keychain — never in plain text.

登录

两种方式通过 GitHub 认证：

OAuth 登录 推荐

通过 Safari 授权，无需手动创建 Token。

  1. 打开 App，点击 Login with GitHub
  2. 系统弹出 Safari 视图，跳转至 GitHub 授权页
  3. 用 GitHub 账号登录，点击 Authorize
  4. 自动返回 App，完成登录
所需权限：repo（仓库读写）、user（用户信息）、gist（创建 Gist）。若你之前已登录但未包含 gist 权限，请退出后重新授权。

PAT 登录（个人访问令牌）

适合希望手动管理 Token 的用户。

  1. 在 GitHub：Settings → Developer settings → Personal access tokens → Tokens (classic)
  2. 生成新 Token，勾选 repo、gist、read:user 权限
  3. 复制 Token（离开页面后无法再次查看）
  4. 在 App 中点击 Login with PAT，粘贴 Token
Token 加密保存在 iOS Keychain 中，不会明文存储。

Repositories

Clone a Repository

After login, your GitHub repositories are listed. Tap any repo and select Clone to download it to your device. Large repositories may take a moment on cellular — Wi-Fi is recommended.

Pull Latest Changes

Open the Git panel (bottom tab) and tap Pull to fetch the latest commits from GitHub.

Favorites & Recent

Mark frequently used files as favorites from the ··· menu in the editor. Access favorites and recent files from the top of the file tree.

仓库管理

克隆仓库

登录后可看到你的 GitHub 仓库列表。点击任意仓库，选择 Clone 将文件下载到设备本地。大型仓库在移动网络下可能较慢，建议在 Wi-Fi 环境下操作。

拉取最新改动

打开 Git 面板（底部标签），点击 Pull 拉取 GitHub 上的最新提交。

收藏与最近文件

在编辑器的 ··· 菜单中，可将常用文件标记为收藏。文件树顶部可快速访问收藏和最近编辑的文件。

Editor Basics

The editor has two modes:

Preview Mode

The default view when opening a file. Markdown is rendered with full formatting. Tap anywhere in the document to switch to editing.

Edit Mode

WYSIWYG editing — formatting renders as you type. The keyboard toolbar appears above the keyboard. Dismiss the keyboard (tap the ⌨️ button or swipe down) to save and return to Preview.

Auto-save: Changes are saved locally every time you dismiss the keyboard. Nothing is lost if you switch apps.

编辑器基础

编辑器有两种模式：

预览模式

打开文件后的默认视图。Markdown 渲染为完整格式。点击文档任意位置切换到编辑模式。

编辑模式

所见即所得——边输入边渲染格式。键盘上方出现格式工具栏。点击收起键盘按钮（⌨️）或向下滑动关闭键盘，自动保存并返回预览。

自动保存：每次收起键盘时自动保存到本地。切换 App 不会丢失内容。

Format Toolbar

The toolbar appears above the keyboard in Edit Mode.

ButtonActionToggle Off
↩ / ↪Undo / Redo—
H1Heading 1Tap again
H2Heading 2Tap again
BBoldTap again
IItalicTap again
SStrikethroughTap again
• ListBullet listTap again
1. ListOrdered listTap again
☑Task listTap again
</>Code blockTap again
"BlockquoteTap again
—Horizontal rule—
🔗Insert link—
⌨️Dismiss keyboard—

格式工具栏

编辑模式下键盘上方显示格式工具栏。

按钮操作取消
↩ / ↪撤销 / 重做—
H1一级标题再次点击
H2二级标题再次点击
B加粗再次点击
I斜体再次点击
S删除线再次点击
• 列表无序列表再次点击
1. 列表有序列表再次点击
☑任务列表再次点击
</>代码块再次点击
"引用块再次点击
—分割线—
🔗插入链接—
⌨️收起键盘—

Font Size

Tap the Aa button in the editor's ··· menu to cycle through five sizes:

XS S M L XL

Your preference is saved and applies across all documents.

Coming in v0.5.4: Heading sizes (H1, H2…) will scale proportionally with your chosen font size. Currently, headings use a fixed size regardless of this setting.

字体大小

在编辑器 ··· 菜单中点击 Aa，可在五档字号间切换：

XS S M L XL

设置全局保存，对所有文档生效。

v0.5.4 即将支持：标题字号（H1、H2 等）将随字体大小设置等比缩放。当前版本标题使用固定字号，不受此设置影响。

File Management

Long-press any file or folder in the file tree to open the context menu:

ActionDescription
New FileCreate a new Markdown or text file in the current folder
New FolderCreate a subfolder
RenameRename file or folder
Move ToMove to another folder in the same repository
DeleteDelete the file (requires confirmation)
FavoriteAdd to / remove from favorites
Not yet supported: Images in Markdown documents are not yet rendered inline. You can store image files in the repository, but they won't display in the editor. This is coming in v0.5.4.

文件管理

在文件树中长按任意文件或文件夹，打开上下文菜单：

操作说明
新建文件在当前文件夹中创建新的 Markdown 或文本文件
新建文件夹创建子文件夹
重命名重命名文件或文件夹
移动到移动到同一仓库的其他文件夹
删除删除文件（需二次确认）
收藏添加或取消收藏
尚未支持：Markdown 文档中的图片目前不能内联显示。你可以将图片文件存储在仓库中，但编辑器中不会渲染。此功能将在 v0.5.4 中支持。

Git Operations

Commit & Push

  1. Open the Git panel (bottom tab bar)
  2. Changed files are listed with their status (modified / new / deleted)
  3. Write a commit message and tap Commit & Push

View Diff

Tap any changed file in the Git panel to see a line-by-line diff of your changes.

Discard Changes

Swipe left on a changed file, or use the context menu, to discard changes and revert to the last committed version.

Pull

Tap Pull in the Git panel to fetch the latest commits from GitHub and merge them locally.

Conflict Handling

If a push fails because the remote has new commits, you'll be prompted to pull first. After pulling, if there are conflicts, the conflicting files will be highlighted. Resolve conflicts in the editor, then commit.

Git 操作

提交与推送

  1. 打开底部标签栏的 Git 面板
  2. 查看已修改文件列表（修改 / 新增 / 删除）
  3. 填写 commit 信息，点击 Commit & Push

查看 Diff

点击 Git 面板中任意已修改的文件，可查看逐行 diff。

丢弃改动

在 Git 面板中向左滑动某个文件，或通过上下文菜单，选择丢弃改动，恢复到上一次提交的版本。

拉取

在 Git 面板点击 Pull，拉取 GitHub 上的最新提交并合并到本地。

冲突处理

如果推送失败（远端有新提交），App 会提示你先拉取。拉取后如有冲突，相关文件会被高亮标注。在编辑器中解决冲突后，重新提交即可。

Share & Export

Tap ··· in the editor's top-right corner:

OptionDescriptionRequirement
Share LinkShare the GitHub URL of the filePublic repository
Share as GistCreate a public Gist and share its linkToken needs gist scope
Export HTMLExport the rendered HTML of the document—
Export PDFExport as a PDF file—
Not yet supported: URL links in document text are not yet tappable. This is coming in v0.5.4.

分享与导出

点击编辑器右上角 ··· 菜单：

选项说明前提条件
分享链接分享该文件的 GitHub URL公开仓库
分享为 Gist创建公开 Gist 并分享链接Token 需包含 gist 权限
导出 HTML导出文档的渲染 HTML 文件—
导出 PDF导出为 PDF 文件—
尚未支持：文档正文中的 URL 链接目前不可点击。此功能将在 v0.5.4 中支持。

FAQ

"Share as Gist" shows error: token may be missing 'gist' scope

Your token doesn't have the gist permission. OAuth users: sign out and log in again. PAT users: generate a new token with the gist scope on GitHub.

Clone is very slow or fails

Clone downloads files one by one via GitHub API. Large repositories can take time — use Wi-Fi if possible.

The editor is blank when I return to the app

iOS may terminate the WebView process when the app is in the background for a long time. The app detects this and automatically reloads your content — no action needed, nothing is lost.

Discard doesn't work after a merge conflict

This is a known issue being fixed in v0.5.4. As a workaround, close and reopen the app, then try discard again.

常见问题

"Share as Gist" 提示：token may be missing 'gist' scope

你的 Token 缺少 gist 权限。OAuth 用户：退出登录后重新授权。PAT 用户：在 GitHub 上重新生成包含 gist 权限的 Token 并重新登录。

Clone 非常慢或失败

Clone 通过 GitHub API 逐文件下载，大型仓库耗时较长。建议在 Wi-Fi 环境下操作。

返回 App 后编辑区空白

iOS 可能在长时间后台后终止 WebView 进程。App 会自动检测并重新加载内容，无需手动操作，内容不会丢失。

发生 Git 冲突后 Discard 无效

这是一个已知问题，将在 v0.5.4 中修复。临时解决方法：关闭并重新打开 App 后再尝试 Discard。

Coming Soon

Features not yet available in the current release:

v0.5.4 Next Release
🖼️
Images in Markdown — inline display with pinch-to-zoom
🔗
Tappable links — URLs auto-detected and openable
Aa
Heading font scaling — headings scale with font size setting
🛠
Discard after conflict — fix for discard not working after a merge conflict
v0.6.0 In Development
✦
AI Collaboration — AI reads and writes your files directly. Bring your own API key.

即将推出

当前版本尚不支持的功能：

v0.5.4 下一个版本
🖼️
Markdown 图片显示 — 内联显示，支持双指缩放
🔗
链接可点击 — URL 自动识别并可在浏览器中打开
Aa
标题字体跟随设置 — 标题随字体大小等比缩放
🛠
冲突后 Discard 修复 — 修复 git 冲突后 Discard 失效的问题
v0.6.0 开发中
✦
AI 协作 — AI 直接读写你的文件。支持自带 API Key。