markdown-paper 2.1.1 → 2.2.1

package/README.md

@@ -1,33 +1,97 @@
-以心理学报的格式从 Markdown 生成 PDF / HTML / DOCX 文件
+以心理学报等学术论文的格式从 Markdown 生成 PDF / HTML / DOCX 文件
+
+# 使用方法
+
+## 1 用 Markdown 撰写论文
+
+```markdown
+# 中文标题
+
+#author# 作者信息
+
+#school# 单位信息
+
+#abstract# 摘要内容
+
+#keywords# 关键词内容
+
+## 1 一级标题
+
+### 1.1 二级标题
+
+#### 1.1.1 三级标题
+
+正文
+
+![](图片路径)
+
+> 图片标题
+
+> 表格标题
+
+| 表头1 | 表头2 |
+| :---: | :---: |
+| 内容1 | 内容2 |
+
+##### 参考文献
+
+- 文献1
+- 文献2
+- 文献3
+
+##### 附录
+```
+
+> 详见下方的模板说明
+
+## 2 安装 `Bun`
+
+`Bun` 是一个现代的 `JavaScript` / `TypeScript` 运行环境, 本项目基于 `Bun` 环境开发; 请在官网 [bun.sh](https://bun.sh) 下载并安装 `Bun`, 也可以直接使用 `npm install -g bun` 安装
+
+## 3 安装 `MarkdownPaper`
 
-## 使用方法
 ```bash
-# 安装 Bun (参见 bun.sh)
-...
-# 安装 MarkdownPaper
 bun add -g markdown-paper
-# 使用 (第一个参数为源文件相对路径)
-mdp <path> [--option]
-# 查看使用方法
-mdp
 ```
 
 > 如果您安装过旧版本的 `MarkdownPaper` (小于 `2.0.0`), 请先卸载旧版本再安装新版本
 
+## 4 生成论文
+
+运行 `mdp` 命令以使用 `MarkdownPaper` 命令行工具从 `Markdown` 文件生成论文
+
+如果您不熟悉命令行工具, 可以尝试我的另一个项目 [EasyPaper](https://github.com/LeafYeeXYZ/EasyPaper), 它基于 `MarkdownPaper` 并提供了图形界面
+
+```bash
+# 查看帮助信息
+mdp
+# 从当前工作目录下的 example.md 文件生成 PDF 文件
+mdp example.md
+# 从当前工作目录下的 example.md 文件生成 PDF 文件并输出到指定路径
+mdp example.md --out=D:/example.pdf
+# 从当前工作目录下的 example.md 文件生成 PDF 和 HTML 文件
+mdp example.md --outputHTML
+# 从当前工作目录下的 example.md 文件生成 PDF 和 DOCX 文件
+pip install pdf2docx # 仅生成 DOCX 文件时需要安装 pdf2docx, 只需安装一次
+mdp example.md --outputDOCX
+```
+
 | 参数 | 说明 |
 | :---: | :---: |
 | `--out=xxx` | 输出文件相对路径<br>默认为源文件路径的同名 `PDF` 文件 |
 | `--theme=xxx` | 论文模板, 默认为 `aps` (`Acta Psychologica Sinica`)<br>暂时没有其他模板, 欢迎贡献 |
 | `--outputHTML` | 输出 `HTML` 文件, 默认不输出 |
-| `--outputDOCX` | 输出 `DOCX` 文件, 默认不输出<br>**须先执行 `pip install pdf2docx` 安装依赖**<br>使用时推荐开启 `--hideFooter` 参数 |
+| `--outputDOCX` | 输出 `DOCX` 文件, 默认不输出<br>**须先通过 `python` 安装依赖 `pdf2docx`**<br>使用时推荐开启 `--hideFooter` 参数 |
 
-## 模板说明
+# 模板说明
 `/theme/theme.ts` 中的 `Theme` 抽象类定义了模板的样式, 按照类似于 `aps` 文件夹的结构可自定义模板; 模板可以提供自定义功能
 
-模板制作完成后, 在 `/lib/main.ts` 中导入并添加到 `class Options -> constructor -> case '--theme':` 中即可使用
+模板制作完成后, 在 `/lib/main.ts` 中导入并添加到 `class Options -> constructor -> case '--theme':` 中, 并在下方添加使用文档即可
+
+推荐所有主题的文档和编写格式都尽量与 `aps` 主题保持一致
 
-### APS 模板
-#### 额外命令行参数
+## APS 模板
+### 额外命令行参数
 | 参数 | 说明 |
 | :---: | :---: |
 | `--showTitle` | 在页眉显示文件名, 默认不显示 |
@@ -35,7 +99,7 @@ mdp
 | `--zhPunctuation` | 将正文中的英文标点符号替换为中文标点符号, 默认不替换<br>仅替换 `PDF` 和 `DOCX` 文件 |
 | `--enPunctuation` | 将正文中的中文标点符号替换为英文标点符号, 默认不替换<br>仅替换 `PDF` 和 `DOCX` 文件 |
 
-#### 编写格式
+### 编写格式
 ```markdown
 # 中文标题
 #author# 作者信息
@@ -66,7 +130,8 @@ mdp
 ##### 附录
 ```
 
-## 更新日志
+# 更新日志
+- `2.2.0` (2024-08-26): 优化项目导入导出内容, 优化文档
 - `2.1.1` (2024-07-12): 修复字体错误
 - `2.1.0` (2024-06-26): 支持 `MacOS` 系统, 改为在线加载字体
 - `2.0.0` (2024-06-20): 重构代码, 完善模板功能

package/bin/mdp.ts

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

package/lib/docx.ts

@@ -1,11 +1,10 @@
 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}`
+  const pdfPath = e.data as string
+  await $`pdf2docx convert ${pdfPath}`
     .then(() => {
       postMessage('success')
     })

package/lib/main.ts

@@ -4,10 +4,11 @@ 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'
+import { MarkdownPaperTheme } from '../theme/theme'
+import type { PDFOptions } from 'puppeteer'
 
 /** 应用参数 */
-export class Options {
+class MarkdownPaperOptions {
   /** markdown 文件绝对路径 */
   src: string
   /** pdf 文件绝对路径 */
@@ -17,7 +18,7 @@ export class Options {
   /** 是否输出 docx */
   outputDOCX: boolean
   /** 样式 */
-  theme: Theme
+  theme: MarkdownPaperTheme
   /** 正确格式 */
   static format = `mdp <markdown> [--options]
 
@@ -26,7 +27,6 @@ export class Options {
     --theme=<name>:  论文模板 (默认为 APS)
     --outputHTML:  输出 html 文件 (默认不输出)
     --outputDOCX:  输出 docx 文件 (默认不输出)
-    --browser=<path>:  自定义浏览器路径 (默认为 Edge)
 
     模板的自定义参数见模板说明`
   /**
@@ -90,79 +90,100 @@ export class Options {
 /**
  * 渲染 markdown
  * @param options 参数
+ * @param rawMarkdown 如果传入此参数, 则不再读取文件
  */
-export async function renderMarkdown(options: Options): Promise<void> {
+async function renderMarkdown(
+  options: MarkdownPaperOptions,
+  rawMarkdown?: string,
+): Promise<void> {
   // 读取 markdown 文件
-  let md = await fs.readFile(options.src, { encoding: 'utf-8' })
+  const raw = rawMarkdown ?? await fs.readFile(options.src, { encoding: 'utf-8' })
   // 预处理 markdown
-  md = options.theme.preParseMarkdown(md)
+  const md = await options.theme.preParseMarkdown(raw)
   // 转换 markdown 为 html
-  const html = await marked(md)
-  // 创建网页文件
-  const title = path.basename(options.src).replace('.md', '')
-  let web = `
+  let html = `
     <!DOCTYPE html>
     <html lang="zh-CN">
     <head>
       <meta charset="UTF-8">
-      <title>${title}</title>
+      <title>${path.basename(options.src).replace('.md', '')}</title>
       <style>${options.theme.css}</style>
     </head>
     <body>
-      ${html}
+      ${await marked(md)}
     </body>
     </html>
   `
   // 预处理 html
-  web = options.theme.preParseHTML(web)
+  html = await options.theme.preParseHTML(html)
   // 保存 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
-    }
-  })
-  // 创建浏览器
+  options.outputHTML && await fs.writeFile(options.out.replace('.pdf', '.html'), html)
+  // 保存 pdf 文件
+  await htmlToPdf(
+    html.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
+      }
+    }),
+    options.out,
+    options.theme.pdfOptions
+  )
+  // 保存 docx 文件
+  options.outputDOCX && await pdfToDocx(options.out)
+}
+
+/**
+ * 把 html 转换为 pdf
+ * @param html html 字符串, 图片为 base64
+ * @param dist pdf 文件绝对路径
+ * @param options pdf 参数, 无需设置路径
+ */
+async function htmlToPdf(html: string, dist: string, options: PDFOptions): Promise<void> {
   const browser = await puppeteer.launch()
-  // 创建页面
   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 page.setContent(html)
+  await page.pdf({ path: dist, ...options })
   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
-          }
+}
+
+/**
+ * 把 pdf 转换为 docx
+ * @param pdfPath pdf 文件绝对路径
+ */
+function pdfToDocx(pdfPath: string): Promise<void> {
+  return 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)
-    })
-  }
+    }
+    worker.postMessage(pdfPath)
+  })
+}
+
+export {
+  MarkdownPaperTheme,
+  MarkdownPaperOptions,
+  renderMarkdown,
+  htmlToPdf,
+  pdfToDocx,
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "markdown-paper",
   "type": "module",
-  "version": "2.1.1",
+  "version": "2.2.1",
   "author": {
     "name": "LeafYeeXYZ",
     "email": "xiaoyezi@leafyee.xyz"
@@ -10,8 +10,9 @@
   "scripts": {
     "mdp": "bun ./bin/mdp.ts",
     "pub": "npm publish",
-    "try": "bun mdp ./论文.md --out=./demo/论文 --outputHTML"
+    "try": "bun mdp ./demo/论文.md --outputHTML --outputDOCX"
   },
+  "main": "./lib/main.ts",
   "bin": {
     "mdp": "./bin/mdp.ts"
   },

package/theme/aps/aps.ts

@@ -1,13 +1,13 @@
-import { Theme } from '../theme'
+import { MarkdownPaperTheme } from '../theme'
 import { readFileSync } from 'node:fs'
 import { resolve } from 'node:path'
 import type { PDFOptions } from 'puppeteer-core'
 
-export class APS extends Theme {
+export class APS extends MarkdownPaperTheme {
 
   css: string
-  preParseMarkdown: (md: string) => string
-  preParseHTML: (html: string) => string
+  preParseMarkdown: (md: string) => Promise<string>
+  preParseHTML: (html: string) => Promise<string>
   script: () => void
   pdfOptions: PDFOptions
 
@@ -34,7 +34,7 @@ export class APS extends Theme {
     this.css = readFileSync(resolve(import.meta.dir, 'aps.css'), 'utf-8')
     
     // preParseMarkdown
-    this.preParseMarkdown = (md: string): string => {
+    this.preParseMarkdown = async (md: string): Promise<string> => {
       // 作者
       md = md.replace(/#author# (.*)/mg, '<div class="author">$1</div>')
       // 单位
@@ -48,17 +48,10 @@ export class APS extends Theme {
     }
 
     // preParseHTML
-    this.preParseHTML = (html: string): string => {
+    this.preParseHTML = async (html: string): Promise<string> => {
       // 把包裹图片的 p 标签去掉
       html = html.replace(/<p><img (.*?)><\/p>/g, '<img $1>')
-      // 加载字体
-      // html = html.replace(/<\/head>/, `
-      //   <link rel="preconnect" href="https://fonts.googleapis.com">
-      //   <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-      //   <link href="https://fonts.googleapis.com/css2?family=Noto+Serif+SC:wght@200..900&display=swap" rel="stylesheet">
-      //   <link href="https://fonts.googleapis.com/css2?family=Noto+Sans+SC:wght@200..900&display=swap" rel="stylesheet">
-      //   <link href="https://fonts.googleapis.com/css2?family=Noto+Serif:wght@200..900&display=swap" rel="stylesheet">
-      // `)
+      // 返回处理后的字符串
       return html
     }
 
@@ -125,6 +118,5 @@ export class APS extends Theme {
       headerTemplate: showTitle ? `<div style="font-size: 9px; font-family: 'SimSun'; color: #333; padding: 5px; margin-left: 0.6cm;"> <span class="title"></span> </div>` : `<div></div>`,
       footerTemplate: hideFooter ? `<div></div>` : `<div style="font-size: 9px; font-family: 'SimSun'; color: #333; padding: 5px; margin: 0 auto;">第 <span class="pageNumber"></span> 页 / 共 <span class="totalPages"></span> 页</div>`,
     }
-
   }
 }

package/theme/theme.ts

@@ -1,6 +1,6 @@
 import type { PDFOptions } from 'puppeteer-core'
 
-export abstract class Theme {
+export abstract class MarkdownPaperTheme {
   /**
    * @param args 命令行参数
    * @param cwd 当前工作目录
@@ -24,14 +24,14 @@ export abstract class Theme {
    * @param md markdown 字符串
    * @returns 转换后的 markdown 字符串
    */
-  abstract preParseMarkdown(md: string): string
+  abstract preParseMarkdown(md: string): Promise<string>
   /**
    * 预处理 html 字符串  
    * 将在保存 html 文件前调用
    * @param html html 字符串
    * @returns 转换后的 html 字符串
    */
-  abstract preParseHTML(html: string): string
+  abstract preParseHTML(html: string): Promise<string>
   /**
    * 在网页中要执行的函数  
    * 将在保存 html 文件后调用

package/theme/aps/aps.md

@@ -1,41 +0,0 @@
-# APS 模板
-`Acta Psychologica Sinica`, 心理学报
-
-## 额外命令行参数
-| 参数 | 说明 |
-| :---: | :---: |
-| `--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
-
-##### 附录
-```