oceanpress 1.0.13 → 1.0.14

package/README.md

@@ -2,6 +2,8 @@
 
 这个是 OceanPress 的核心库，包含了前端应用和命令行程序。
 
+**[English Documentation](./README_EN.md)** | 简体中文
+
 ## CLI 命令详解
 
 ### 1. 构建静态站点 (build)
@@ -9,16 +11,26 @@
 将思源笔记本的内容转换为静态网站：
 
 ```bash
-oceanpress build -c <配置文件路径> -o <输出目录>
+oceanpress build -c <配置文件路径> -o <输出目录> [选项]
 ```
 
 **选项：**
 - `-c, --config <string>` - 指定配置文件的位置
 - `-o, --output <string>` - 指定输出目录位置
+- `--md` - 自动启用 Markdown 镜像导出（等同于在配置文件中设置 markdownMirror.enable = true）
+- `--watch` - 启用监听模式，自动重新构建
+- `--watch-interval <number>` - 监听模式的检查间隔（秒），默认 60 秒
 
 **示例：**
 ```bash
+# 基础构建
 oceanpress build -c ./config.json -o ./dist
+
+# 构建并启用 Markdown 镜像导出
+oceanpress build -c ./config.json -o ./dist --md
+
+# 启用监听模式，每 30 秒检查一次更新
+oceanpress build -c ./config.json -o ./dist --watch --watch-interval 30
 ```
 
 ### 2. 启动开发服务器 (server)
@@ -74,6 +86,38 @@ OceanPress 使用 JSON 格式的配置文件来定义站点的基本信息和构
 - 主题和样式设置
 - 插件配置
 
+### MarkdownMirror 插件配置
+
+MarkdownMirror 插件可以自动将生成的 HTML 文档转换为 Markdown 格式，便于与 NotebookLM 等工具集成。
+
+**配置示例：**
+```json
+{
+  "markdownMirror": {
+    "enable": true,
+    "outputDir": "/path/to/output",
+    "includeAssets": false
+  }
+}
+```
+
+**配置选项：**
+- `enable` - 是否启用 Markdown 镜像导出
+- `outputDir` - Markdown 文件输出目录（通常与构建输出目录相同）
+- `includeAssets` - 是否同步资源文件（图片、附件等），默认 false
+
+**功能特性：**
+- 自动将 HTML 文档转换为 Markdown 格式
+- 自动删除生成的 HTML 文件，仅保留 Markdown
+- 智能转换内部链接（.html → .md + 标题锚点）
+- 移除思源模板生成的多余内容（版权信息、SiYuan 相关链接等）
+- 优化代码块格式和空白字符
+
+**使用方式：**
+1. 在配置文件中启用 `markdownMirror.enable = true`
+2. 运行 `oceanpress build --md` 或直接在配置中设置
+3. 输出目录将生成 Markdown 文件，可直接导入 NotebookLM
+
 ## 技术栈
 
 - Vue 3

package/README_EN.md

@@ -0,0 +1,131 @@
+# OceanPress Frontend
+
+This is the core library of OceanPress, including the frontend application and command-line tool.
+
+English | **[简体中文文档](./README.md)**
+
+## CLI Commands
+
+### 1. Build Static Site (build)
+
+Convert SiYuan notebook content to a static website:
+
+```bash
+oceanpress build -c <config_path> -o <output_dir> [options]
+```
+
+**Options:**
+- `-c, --config <string>` - Specify the configuration file location
+- `-o, --output <string>` - Specify the output directory location
+- `--md` - Automatically enable Markdown mirror export (equivalent to setting markdownMirror.enable = true in config)
+- `--watch` - Enable watch mode for automatic rebuilds
+- `--watch-interval <number>` - Check interval for watch mode (seconds), default 60 seconds
+
+**Examples:**
+```bash
+# Basic build
+oceanpress build -c ./config.json -o ./dist
+
+# Build with Markdown mirror export
+oceanpress build -c ./config.json -o ./dist --md
+
+# Enable watch mode with 30-second interval
+oceanpress build -c ./config.json -o ./dist --watch --watch-interval 30
+```
+
+### 2. Start Development Server (server)
+
+Run a dynamic proxy server for development and preview:
+
+```bash
+oceanpress server -c <config_path>
+```
+
+**Options:**
+- `-c, --config <string>` - Specify the configuration file location
+- `-h, --host <string>` - Web service binding address (default: 127.0.0.1)
+- `-p, --port <number>` - Web service binding port (default: 80)
+- `--cache <boolean>` - Set to true to enable caching, default false
+
+**Examples:**
+```bash
+# Use default port
+oceanpress server -c ./config.json
+
+# Specify port and host
+oceanpress server -c ./config.json -p 3000 -h 0.0.0.0
+
+# Enable caching
+oceanpress server -c ./config.json --cache true
+```
+
+### 3. Deploy Site (deploy)
+
+Deploy the generated site to a remote server:
+
+```bash
+oceanpress deploy -c <config_path> -h <api_url> -k <api_key>
+```
+
+**Options:**
+- `-c, --config <string>` - Specify the configuration file location
+- `-h, --apiBase <string>` - OceanPress server address
+- `-k, --apiKey <string>` - OceanPress server API key
+
+**Examples:**
+```bash
+oceanpress deploy -c ./config.json -h https://api.example.com -k your-api-key
+```
+
+## Configuration File
+
+OceanPress uses JSON format configuration files to define site information and build parameters. Configuration files typically include:
+
+- Site name and description
+- SiYuan notebook connection configuration
+- Theme and style settings
+- Plugin configuration
+
+### MarkdownMirror Plugin Configuration
+
+The MarkdownMirror plugin automatically converts generated HTML documents to Markdown format, making it easy to integrate with tools like NotebookLM.
+
+**Configuration Example:**
+```json
+{
+  "markdownMirror": {
+    "enable": true,
+    "outputDir": "/path/to/output",
+    "includeAssets": false
+  }
+}
+```
+
+**Configuration Options:**
+- `enable` - Enable Markdown mirror export
+- `outputDir` - Markdown file output directory (usually same as build output directory)
+- `includeAssets` - Whether to sync asset files (images, attachments, etc.), default false
+
+**Features:**
+- Automatically convert HTML documents to Markdown format
+- Automatically delete generated HTML files, keeping only Markdown
+- Smart internal link conversion (.html → .md + title anchors)
+- Remove redundant template content (copyright info, SiYuan links, etc.)
+- Optimize code blocks and whitespace
+
+**Usage:**
+1. Enable `markdownMirror.enable = true` in configuration file
+2. Run `oceanpress build --md` or set directly in configuration
+3. Output directory will contain Markdown files, ready to import into NotebookLM
+
+## Tech Stack
+
+- Vue 3
+- TypeScript
+- Hono
+- Effect
+- Commander.js
+
+## Development
+
+You can use Claude to execute the `/full-release` command to automatically update dependencies and push to npm.

package/dist-cli/cli.js

@@ -77,7 +77,7 @@ import { computed, reactive, watch } from "vue";
 // package.json
 var package_default = {
   name: "oceanpress",
-  version: "1.0.13",
+  version: "1.0.14",
   type: "module",
   description: "\u4ECE\u601D\u6E90\u7B14\u8BB0\u672C\u751F\u6210\u9759\u6001\u7AD9\u70B9\u7684\u5DE5\u5177",
   author: "siyuan-note",