Add helpdoc system with interactive viewer

6 files changed, 61 insertions, 0 deletions

diff --git a/resources/helpdoc/commands/hexdump.en.md b/resources/helpdoc/commands/hexdump.en.md
new file mode 100644
index 0000000..60d5275
--- /dev/null
+++ b/resources/helpdoc/commands/hexdump.en.md
@@ -0,0 +1,6 @@
+# Hexdump
+
+> Print binary information
+
+## Usage
+jvn hexdump <FILE>
diff --git a/resources/helpdoc/commands/hexdump.zh-CN.md b/resources/helpdoc/commands/hexdump.zh-CN.md
new file mode 100644
index 0000000..9b5b8ad
--- /dev/null
+++ b/resources/helpdoc/commands/hexdump.zh-CN.md
@@ -0,0 +1,6 @@
+# Hexdump
+
+> 打印二进制信息
+
+## 使用
+jvn hexdump <FILE>
diff --git a/resources/helpdoc/commands/sheetdump.en.md b/resources/helpdoc/commands/sheetdump.en.md
new file mode 100644
index 0000000..1616f12
--- /dev/null
+++ b/resources/helpdoc/commands/sheetdump.en.md
@@ -0,0 +1,13 @@
+# Sheetdump
+
+> Visually output the internal structure of a `Sheet`
+
+## Usage
+jvn sheetdump <SHEET_FILE>              # Default output
+jvn sheetdump <SHEET_FILE> --no-sort    # No sorting
+jvn sheetdump <SHEET_FILE> --no-pretty  # No prettifying
+
+## Tip
+You can also use `renderer override` to access the internal structure of a `Sheet`, 
+for example:
+jvn sheetdump <SHEET_FILE> --renderer json | jq ".mappings"
diff --git a/resources/helpdoc/commands/sheetdump.zh-CN.md b/resources/helpdoc/commands/sheetdump.zh-CN.md
new file mode 100644
index 0000000..0ae46ef
--- /dev/null
+++ b/resources/helpdoc/commands/sheetdump.zh-CN.md
@@ -0,0 +1,12 @@
+# Sheetdump
+
+> 可视化地输出 `Sheet` 的内部结构
+
+## 使用
+jvn sheetdump <SHEET_FILE>              # 默认输出
+jvn sheetdump <SHEET_FILE> --no-sort    # 无排序
+jvn sheetdump <SHEET_FILE> --no-pretty  # 无美化
+
+## 提示
+您也可以使用 `渲染器重载` 来访问 `Sheet` 的内部结构，例如
+jvn sheetdump <SHEET_FILE> --renderer json | jq ".mappings"
diff --git a/resources/helpdoc/commands/sheetedit.en.md b/resources/helpdoc/commands/sheetedit.en.md
new file mode 100644
index 0000000..80f2a7b
--- /dev/null
+++ b/resources/helpdoc/commands/sheetedit.en.md
@@ -0,0 +1,12 @@
+# Sheetedit
+
+> Edit `Sheet` files using your system editor
+
+## Usage
+jvn sheetedit <FILE>
+
+## Note
+It reads and uses a command-line editor program in the following priority order:
+1. JV\_TEXT\_EDITOR
+2. EDITOR
+3. If neither exists, it falls back to using `jvii`
diff --git a/resources/helpdoc/commands/sheetedit.zh-CN.md b/resources/helpdoc/commands/sheetedit.zh-CN.md
new file mode 100644
index 0000000..f30825a
--- /dev/null
+++ b/resources/helpdoc/commands/sheetedit.zh-CN.md
@@ -0,0 +1,12 @@
+# Sheetedit
+
+> 使用系统编辑器修改 `Sheet` 文件
+
+## 使用
+jvn sheetedit <FILE>
+
+## 注意
+它读取按照以下优先级寻找命令行编辑器程序：
+1. JV\_TEXT\_EDITOR
+2. EDITOR 
+3. 若都不存在，使用 `jvii` 回退