# js-mdx-server

**Repository Path**: wamich/js-mdx-server

## Basic Information

- **Project Name**: js-mdx-server
- **Description**: 注意此仓库为镜像github仓库！(https://github.com/wamich/js-mdx-server)
为方便个人词库插件使用，提供支持多mdd文件的本地词典服务器。
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: https://mingchang.wang
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2024-11-11
- **Last Updated**: 2025-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# js-mdx-server

> 基于 [terasum/js-mdict](https://github.com/terasum/js-mdict)

## 支持多 mdd 文件

推荐词典: [精装 - 牛津高阶双解第 10 版完美版（OALDPE）](https://forum.freemdict.com/t/topic/30466)。  
下载完该词典后，请进一步参考 [词典适配说明](https://mingchang.wang/FAQ#mdx)。

## 前提

- 下载

  ```sh
  git clone --recurse-submodules https://github.com/wamich/js-mdx-server.git
  ```

- 安装 node.js:

  - 下载地址: https://nodejs.org/zh-cn

- 安装 依赖:

  ```sh
  npm install
  # 或者
  pnpm install
  ```

## 说明

- **main.ts**: 程序主入口
- **injection.html**: 公共的注入内容，每个词典都会注入。参考 [ninja33/mdx-server](https://github.com/ninja33/mdx-server)
- 如需为特定 mdx 词典定制或修复时，一般有几种方法：

  1. 直接修改 mdx 词典引用的 js 或 css 文件
  2. 可在该 mdx 词典目录下，新建一个 html 文件，以实现注入独特定的需求。示例：

  ```html
  <!-- 如为单独的词典（CED_231010_v231014.mdx），进行自定义。 -->
  <!-- 原词典内容：特殊单词之间没有空格，而采用是边距隔开。 -->
  <script>
    // inject js
    document.querySelectorAll("div.ced23 a").forEach((a) => {
      // 特殊单词前后插入空格字符串
      a.insertAdjacentText("beforebegin", " ");
      a.insertAdjacentText("afterend", " ");
    });
  </script>
  <style>
    /* inject css */
    div.ced23 a {
      /* 禁止边距分割 */
      margin: 0px !important;
    }
  </style>
  ```

## 运行

> **命令行参数**

```sh
npx tsx main.ts -h

当前版本: v0.2

Usage(使用): npx tsx main.ts [options]

Options（参数说明）:
  -h, --help         显示帮助信息
  -p, --port: (可选)。服务运行端口，默认端口：3000
  -d, --dir:  (必填)。请指定绝对路径！示例如下：
      1. 一个 mdx 文件时，dir 参数为: *父级目录* 的绝对路径。
        └── *父级目录*
            └── oaldpe.mdx
      2. 多个 mdx 文件时，dir 参数为: *祖父级目录* 的绝对路径。
        └── *祖父级目录*
            ├── 精选牛津十
            │   ├── oaldpe.mdx
            │   ├── oaldpe.mdd
            │   ├── oaldpe1.mdd
            │   ├── oaldpe2.mdd
            │   ├── oaldpe3.mdd
            │   └── oaldpe4.mdd
            └── 21 世纪英汉词典
                └── 21 世纪英汉词典.mdx
```

1. 运行方式一：(直接运行)

   ```sh
   npx tsx main.ts --dir='你的目录!' --port=3000

   # mac 示例:
   npx tsx main.ts --dir='/Users/ming/dict-workspace/dictionaries' --port=3000

   # win 示例:
   npx tsx main.ts --dir='C:\Users\Ming\Downloads\OALD 2024.09' --port=3000
   ```

2. 运行方式二：(调试运行)

   - 据实修改 **package.json** 中，**scripts** 字段中 **--dir 参数**、**--port 参数**。

   ```json
   {
     "scripts": {
       "dev": "tsx watch main.ts --dir='/Users/ming/dict-workspace/dictionaries' --port=3000"
     }
   }
   ```

   - 执行:

   ```sh
   npm run dev
   ```