文档更新

Author: Yuki-Nagori

README.md

@@ -9,7 +9,7 @@
 - AI 编程友好
 - 小巧且快速
 
-<img src="GoldfishScheme-logo.png" alt="示例图片" style="width: 360pt;">
+<img src="./docs/public/GoldfishScheme-logo.png" alt="示例图片" style="width: 360pt;">
 
 ## 以简为美
 

README_ZH.md

@@ -9,7 +9,7 @@
 - AI 编程友好
 - 小巧且快速
 
-<img src="GoldfishScheme-logo.png" alt="示例图片" style="width: 360pt;">
+<img src="./docs/public/GoldfishScheme-logo.png" alt="示例图片" style="width: 360pt;">
 
 ## 以简为美
 

docs/.vitepress/config.mts

@@ -4,13 +4,13 @@ import { defineConfig } from 'vitepress'
 export default defineConfig({
   title: 'Goldfish Scheme',
   description: '让 Scheme 和 Python 一样易用且实用',
-  
+
   // 构建输出目录 (docs/dist/)
   outDir: './dist',
-  
+
   // 基础配置 (GitHub Pages 项目站点需要设置子路径)
   base: '/case-lambda/',
-  
+
   // 清理 URL
   cleanUrls: true,
 })

docs/api/index.md

@@ -0,0 +1,36 @@
+# API 文档
+
+Goldfish Scheme 提供了丰富的 API，分为三个主要部分：
+
+## Liii 库
+
+Goldfish Scheme 的扩展库，提供类似 Python 的实用功能。
+
+- [基础库](./liii/) - `(liii base)`, `(liii error)`, `(liii check)`
+- [数据结构](./liii/) - `(liii list)`, `(liii vector)`, `(liii string)`,
+  `(liii hash-table)`
+- [系统与 IO](./liii/) - `(liii sys)`, `(liii os)`, `(liii path)`
+- [网络与数据](./liii/) - `(liii http)`, `(liii json)`, `(liii uuid)`
+- [函数式编程](./liii/) - `(liii case)`, `(liii option)`, `(liii either)`,
+  `(liii range)`
+
+## SRFI
+
+Scheme Request for Implementation 标准实现。
+
+- [SRFI-1](./srfi/) - List 库
+- [SRFI-8](./srfi/) - Receive
+- [SRFI-9](./srfi/) - Records
+- [SRFI-13](./srfi/) - String 库
+- [SRFI-16](./srfi/) - Case-lambda
+- [更多...](./srfi/)
+
+## R7RS 标准
+
+R7RS-small 标准库。
+
+- [(scheme base)](./scheme/) - 基础库
+- [(scheme case-lambda)](./scheme/) - Case-lambda
+- [(scheme char)](./scheme/) - 字符库
+- [(scheme file)](./scheme/) - 文件操作
+- [(scheme time)](./scheme/) - 时间库

docs/api/liii/base.md

@@ -0,0 +1,101 @@
+# (liii base)
+
+基础例程库，扩展了 R7RS `(scheme base)`。
+
+## 导入
+
+```scheme
+(import (liii base))
+```
+
+## 函数
+
+### 比较操作
+
+#### `==`
+
+数值相等比较。
+
+```scheme
+(== 1 1)     ; => #t
+(== 1 1.0)   ; => #t
+```
+
+#### `!=`
+
+数值不等比较。
+
+```scheme
+(!= 1 2)     ; => #t
+(!= 1 1)     ; => #f
+```
+
+### 函数操作
+
+#### `compose`
+
+函数组合。
+
+```scheme
+((compose square add1) 5)   ; => 36
+```
+
+#### `identity`
+
+恒等函数。
+
+```scheme
+(identity 42)   ; => 42
+```
+
+#### `any?`
+
+总是返回 `#t` 的谓词。
+
+```scheme
+(any? 'foo)     ; => #t
+(any? 123)      ; => #t
+```
+
+### 列表操作
+
+#### `loose-car`
+
+安全的 `car`，空列表返回空列表。
+
+```scheme
+(loose-car '(1 2 3))   ; => 1
+(loose-car '())        ; => ()
+```
+
+#### `loose-cdr`
+
+安全的 `cdr`，空列表返回空列表。
+
+```scheme
+(loose-cdr '(1 2 3))   ; => (2 3)
+(loose-cdr '())        ; ()
+```
+
+### 宏
+
+#### `typed-lambda`
+
+带类型检查的 lambda。
+
+```scheme
+((typed-lambda ((n integer?))
+   (* n n)) 5)           ; => 25
+
+((typed-lambda ((n integer?))
+   (* n n)) "foo")       ; => error: type-error
+```
+
+## R7RS 基础
+
+同时导出 R7RS `(scheme base)` 的所有绑定：
+
+- 定义: `define`, `lambda`, `case`, `cond`, `if`
+- 数值: `+`, `-`, `*`, `/`, `abs`, `square`, `max`, `min`
+- 列表: `cons`, `car`, `cdr`, `list`, `map`, `append`
+- 等等...

docs/api/liii/bitwise.md

@@ -0,0 +1,108 @@
+# (liii bitwise)
+
+位运算库，基于 SRFI-151。
+
+## 导入
+
+```scheme
+(import (liii bitwise))
+```
+
+## 基本运算
+
+### `bitwise-and`
+
+按位与。
+
+```scheme
+(bitwise-and 5 3)
+;; => 1  ; 101 & 011 = 001
+```
+
+### `bitwise-ior`
+
+按位或。
+
+```scheme
+(bitwise-ior 5 3)
+;; => 7  ; 101 | 011 = 111
+```
+
+### `bitwise-xor`
+
+按位异或。
+
+```scheme
+(bitwise-xor 5 3)
+;; => 6  ; 101 ^ 011 = 110
+```
+
+### `bitwise-not`
+
+按位非。
+
+```scheme
+(bitwise-not 5)
+;; => -6  ; ~101 = ...11111010
+```
+
+## 位移
+
+### `arithmetic-shift`
+
+算术移位。
+
+```scheme
+(arithmetic-shift 5 2)
+;; => 20  ; 5 << 2 = 10100
+
+(arithmetic-shift 20 -2)
+;; => 5   ; 20 >> 2 = 101
+```
+
+## 位测试
+
+### `bit-set?`
+
+测试位是否设置。
+
+```scheme
+(bit-set? 0 5)
+;; => #t  ; 5 = 101, bit 0 is 1
+
+(bit-set? 1 5)
+;; => #f  ; 5 = 101, bit 1 is 0
+
+(bit-set? 2 5)
+;; => #t  ; 5 = 101, bit 2 is 1
+```
+
+## 位操作
+
+### `copy-bit`
+
+设置或清除某一位。
+
+```scheme
+(copy-bit 1 5 #t)
+;; => 7  ; 101 -> 111
+
+(copy-bit 0 5 #f)
+;; => 4  ; 101 -> 100
+```
+
+### `bit-count`
+
+计算置位位数。
+
+```scheme
+(bit-count 5)
+;; => 2  ; 101 has 2 bits set
+
+(bit-count -1)
+;; => -1 ; all bits set in two's complement
+```
+
+## 更多函数
+
+更多位运算函数请参见 [(srfi srfi-151)](../srfi/srfi-151.md)。

docs/api/liii/case.md

@@ -0,0 +1,41 @@
+# (liii case)
+
+模式匹配库。
+
+## 导入
+
+```scheme
+(import (liii case))
+```
+
+## 函数
+
+### `case*`
+
+增强的 `case` 表达式，支持模式匹配。
+
+```scheme
+(case* expr
+  (pattern1 result1)
+  (pattern2 result2)
+  (else default-result))
+```
+
+## 示例
+
+```scheme
+(import (liii case)
+        (liii base))
+
+;; 基本模式匹配
+(case* '(1 2 3)
+  ((a b c) (+ a b c))
+  (else 0))
+;; => 6
+
+;; 匹配列表
+(case* '(hello world)
+  ((x y) (list y x))
+  (else '()))
+;; => (world hello)
+```

docs/api/liii/check.md

@@ -0,0 +1,65 @@
+# (liii check)
+
+基于 SRFI-78 的轻量级测试框架。
+
+## 导入
+
+```scheme
+(import (liii check))
+```
+
+## 函数
+
+### `check`
+
+检查表达式是否等于期望值。
+
+```scheme
+(check (+ 1 2) => 3)
+(check (square 5) => 25)
+```
+
+### `check-catch`
+
+检查是否抛出指定异常。
+
+```scheme
+(check-catch 'type-error (require-int "foo"))
+(check-catch 'value-error (safe-divide 1 0))
+```
+
+### `check-report`
+
+输出测试报告。
+
+```scheme
+(check-report)
+;; => *** checks *** : 10 correct, 0 failed.
+```
+
+## 完整示例
+
+```scheme
+(import (liii base)
+        (liii check))
+
+(define (square n) (* n n))
+(define (factorial n)
+  (if (= n 0)
+      1
+      (* n (factorial (- n 1)))))
+
+(check (square 5) => 25)
+(check (factorial 5) => 120)
+(check (+ 1 2 3) => 6)
+
+(check-report)
+```
+
+## 运行测试
+
+```bash
+gf test
+# 或
+gf my-test.scm
+```