markdown-paper 2.0.0

package/README.md

@@ -0,0 +1,83 @@
+以心理学报的格式从 Markdown 生成 PDF / HTML / DOCX 文件
+
+## 使用方法
+```bash
+# 安装 Bun (参见 bun.sh)
+...
+# 安装 MarkdownPaper
+bun add -g markdown-paper
+# 使用 (第一个参数为源文件相对路径)
+mdp <path> [--option]
+# 查看使用方法
+mdp
+```
+
+> 如果您安装过旧版本的 `MarkdownPaper` (小于 `2.0.0`), 请先卸载旧版本再安装新版本
+
+| 参数 | 说明 |
+| :---: | :---: |
+| `--out=xxx` | 输出文件相对路径<br>默认为源文件路径的同名 `PDF` 文件 |
+| `--browser=xxx` | 浏览器绝对路径, 非 `Windows` 系统则必须<br>默认为 `C:\\Program Files (x86)\\Microsoft\\Edge\\Application\\msedge.exe` |
+| `--theme=xxx` | 论文模板, 默认为 `aps` (`Acta Psychologica Sinica`)<br>暂时没有其他模板, 欢迎贡献 |
+| `--outputHTML` | 输出 `HTML` 文件, 默认不输出 |
+| `--outputDOCX` | 输出 `DOCX` 文件, 默认不输出<br>**须先执行 `pip install pdf2docx` 安装依赖**<br>使用时推荐开启 `--hideFooter` 参数 |
+
+## 模板说明
+`/theme/theme.ts` 中的 `Theme` 抽象类定义了模板的样式, 按照类似于 `aps` 文件夹的结构可自定义模板; 模板可以提供自定义功能
+
+模板制作完成后, 在 `/lib/main.ts` 中导入并添加到 `class Options -> constructor -> case '--theme':` 中即可使用
+
+### APS 模板
+#### 额外命令行参数
+| 参数 | 说明 |
+| :---: | :---: |
+| `--showTitle` | 在页眉显示文件名, 默认不显示 |
+| `--hideFooter` | 隐藏页码, 默认显示 |
+| `--zhPunctuation` | 将正文中的英文标点符号替换为中文标点符号, 默认不替换<br>仅替换 `PDF` 和 `DOCX` 文件 |
+| `--enPunctuation` | 将正文中的中文标点符号替换为英文标点符号, 默认不替换<br>仅替换 `PDF` 和 `DOCX` 文件 |
+
+#### 编写格式
+```markdown
+# 中文标题
+#author# 作者信息
+#school# 单位信息
+#abstract# 摘要内容
+#keywords# 关键词内容
+
+## 1 一级标题
+### 1.1 二级标题
+#### 1.1.1 三级标题
+正文
+
+![](图片路径)
+
+> 图片标题
+
+> 表格标题
+
+| 表头1 | 表头2 |
+| :---: | :---: |
+| 内容1 | 内容2 |
+
+##### 参考文献
+- 文献1
+- 文献2
+- 文献3
+
+##### 附录
+```
+
+## 更新日志
+- `2.0.0` (2024-06-20): 重构代码, 完善模板功能
+- `1.4.0` (2024-05-29): 新增替换中英文标点符号功能
+- `1.3.2` (2024-05-28): 优化图表标题显示
+- `1.3.1` (2024-05-28): 优化样式
+- `1.3.0` (2024-05-26): 支持自定义 `CSS` 文件, 简化编写格式, 优化帮助信息
+- `1.2.3` (2024-05-25): 修复中文图片路径导致的错误
+- `1.2.2` (2024-05-21): 优化样式, 优化命令
+- `1.2.1` (2024-05-21): 优化摘要样式
+- `1.2.0` (2024-05-21): 支持表格, 优化书写语法
+- `1.1.3` (2024-05-20): 修复图片显示问题, 并新增显示图片标题
+- `1.1.2` (2024-05-20): 优化 `DOCX` 文件输出
+- `1.1.1` (2024-05-19): 支持 `DOCX` 文件输出
+- `1.0.0` (2024-05-19): 初版发布

package/bin/mdp.ts

@@ -0,0 +1,37 @@
+#!/usr/bin/env bun
+
+import { Options, renderMarkdown } from '../lib/main.ts'
+/** 命令行参数 */
+const args = process.argv.slice(2)
+/** 当前工作目录 */
+const cwd = process.cwd()
+/**
+ * 主函数
+ * @param args 命令行参数
+ * @param cwd 当前工作目录
+ */
+void async function main(args: string[], cwd: string) {
+  try {
+    // 如果没有参数, 显示帮助信息
+    if (args.length === 0) {
+      console.log(`\n使用方法:\n${Options.format}\n`)
+      process.exit(0)
+    }
+    // 解析参数
+    console.log('\n开始生成\n')
+    const options = new Options(args, cwd)
+    // 渲染 markdown
+    await renderMarkdown(options)
+    console.log('生成成功\n')
+  } 
+  catch (e) {
+    if (e instanceof SyntaxError) {
+      console.error(`参数错误, 正确格式:\n${Options.format}\n`)
+    } else if (e instanceof Error) {
+      console.error(`错误:\n${e.message}\n`)
+    }
+  } 
+  finally {
+    process.exit(0)
+  }
+}(args, cwd)

package/lib/docx.ts

@@ -0,0 +1,18 @@
+declare var self: Worker
+
+import { $ } from 'bun'
+import { Options } from './main'
+
+self.onmessage = async (e) => {
+  const options = e.data as Options
+  await $`pdf2docx convert ${options.out}`
+    .then(() => {
+      postMessage('success')
+    })
+    .catch(() => {
+      postMessage('error')
+    })
+    .finally(() => {
+      process.exit(0)
+    })
+}

package/lib/main.ts

@@ -0,0 +1,177 @@
+import { marked } from 'marked'
+import puppeteer from 'puppeteer-core'
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import { readFileSync } from 'node:fs'
+import { APS } from '../theme/aps/aps'
+import { Theme } from '../theme/theme'
+
+/** 应用参数 */
+export class Options {
+  /** markdown 文件绝对路径 */
+  src: string
+  /** pdf 文件绝对路径 */
+  out: string
+  /** 自定义浏览器 */
+  browser: string
+  /** 是否输出 html */
+  outputHTML: boolean
+  /** 是否输出 docx */
+  outputDOCX: boolean
+  /** 样式 */
+  theme: Theme
+  /** 正确格式 */
+  static format = `mdp <markdown> [--options]
+
+    <markdown>:  markdown 文件相对路径
+    --out=<path>:  输出文件相对路径 (默认为 <markdown>)
+    --theme=<name>:  论文模板 (默认为 APS)
+    --outputHTML:  输出 html 文件 (默认不输出)
+    --outputDOCX:  输出 docx 文件 (默认不输出)
+    --browser=<path>:  自定义浏览器路径 (默认为 Edge)
+
+    模板的自定义参数见模板说明`
+  /**
+   * 生成应用参数
+   * @param args 命令行参数
+   * @param cwd 当前工作目录
+   */
+  constructor(args: string[], cwd: string) {
+    // 默认参数
+    this.src = ''
+    this.out = ''
+    this.outputHTML = false
+    this.outputDOCX = false
+    this.theme = new APS(args, cwd)
+    this.browser = 'C:\\Program Files (x86)\\Microsoft\\Edge\\Application\\msedge.exe'
+    // 解析路径参数
+    if (args.length === 0) throw SyntaxError()
+    else args[0] = `--src=${args[0]}`
+    // 解析其他参数
+    args.forEach(arg => {
+      switch (arg.split('=')[0]) {
+        case '--src': {
+          const a = arg.split('=')
+          if (a.length !== 2 || a[1] === '') throw SyntaxError()
+          this.src = a[1].endsWith('.md') ? path.resolve(cwd, a[1]) : path.resolve(cwd, a[1] + '.md')
+          break
+        }
+        case '--out': {
+          const a = arg.split('=')
+          if (a.length !== 2 || a[1] === '') throw SyntaxError()
+          this.out = a[1].endsWith('.pdf') ? path.resolve(cwd, a[1]) : path.resolve(cwd, a[1] + '.pdf')
+          break
+        }
+        case '--theme': {
+          const a = arg.split('=')
+          if (a.length !== 2 || a[1] === '') throw SyntaxError()
+          switch (a[1].toUpperCase()) {
+            case 'APS': {
+              break
+            }
+            default: {
+              throw Error(`模板 ${a[1]} 不存在`)
+            }
+          }
+          break
+        }
+        case '--outputHTML': {
+          this.outputHTML = true
+          break
+        }
+        case '--outputDOCX': {
+          this.outputDOCX = true
+          break
+        }
+        case '--browser': {
+          const a = arg.split('=')
+          if (a.length !== 2 || a[1] === '') throw SyntaxError()
+          this.browser = a[1]
+          break
+        }
+      }
+    })
+    // 检查参数
+    if (this.out === '') this.out = this.src.replace('.md', '.pdf')
+  }
+}
+
+/**
+ * 渲染 markdown
+ * @param options 参数
+ */
+export async function renderMarkdown(options: Options): Promise<void> {
+  // 读取 markdown 文件
+  let md = await fs.readFile(options.src, { encoding: 'utf-8' })
+  // 预处理 markdown
+  md = options.theme.preParseMarkdown(md)
+  // 转换 markdown 为 html
+  const html = await marked(md)
+  // 创建网页文件
+  const title = path.basename(options.src).replace('.md', '')
+  let web = `
+    <!DOCTYPE html>
+    <html lang="zh-CN">
+    <head>
+      <meta charset="UTF-8">
+      <title>${title}</title>
+      <style>${options.theme.css}</style>
+    </head>
+    <body>
+      ${html}
+    </body>
+    </html>
+  `
+  // 预处理 html
+  web = options.theme.preParseHTML(web)
+  // 保存 html 文件
+  options.outputHTML && await fs.writeFile(options.out.replace('.pdf', '.html'), web)
+  // 把图片转换为 base64
+  web = web.replace(/<img src="(.+?)"/g, (match, p1) => {
+    if (p1.startsWith('http')) return match
+    try {
+      const url = path.resolve(path.dirname(options.src), decodeURI(p1))
+      const data = readFileSync(url).toString('base64')
+      return `<img src="data:image/${path.extname(p1).replace('.', '')};base64,${data}"`
+    } catch (_) {
+      console.error(`图片 ${p1} 不存在`)
+      return match
+    }
+  })
+  // 创建浏览器
+  const browser = await puppeteer.launch({ executablePath: options.browser })
+  // 创建页面
+  const page = await browser.newPage()
+  // 设置页面内容
+  await page.setContent(web)
+  // 执行脚本
+  await page.evaluate(options.theme.script)
+  // 生成 pdf
+  await page.pdf({ path: options.out, ...options.theme.pdfOptions })
+  // 关闭浏览器
+  await browser.close()
+  // 保存 docx 文件
+  if (options.outputDOCX) {
+    await new Promise<void>((resolve, reject) => {
+      const worker = new Worker(new URL('docx.ts', import.meta.url).href)
+      worker.onmessage = (e) => {
+        switch (e.data) {
+          case 'success': {
+            console.log('')
+            resolve()
+            break
+          }
+          case 'error': {
+            reject(Error('生成 docx 文件失败'))
+            break
+          }
+          default: {
+            reject(Error('调用 Python 时发生未知错误'))
+            break
+          }
+        }
+      }
+      worker.postMessage(options)
+    })
+  }
+}