markdown-paper 2.4.0 → 3.0.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
+
+## 3.0.0 (2025-06-09)
+
+
+### ⚠ BREAKING CHANGES
+
+* 重构代码
+
+### Refactoring
+
+* 重构代码 ([1702525](https://github.com/LeafYeeXYZ/MarkdownPaper/commit/1702525d7bf4a9470de8aeabb0cad1e7abff6e56))

package/README.md

@@ -53,6 +53,10 @@ $$
 - 文献2
 - 文献3
 
+--- 
+
+(上面的是分页符)
+
 ##### 附录
 ```
 
@@ -60,7 +64,7 @@ $$
 
 ## 2 安装 `Bun`
 
-`Bun` 是一个现代的 `JavaScript` / `TypeScript` 运行环境, 本项目基于 `Bun` 环境开发; 请在官网 [bun.sh](https://bun.sh) 下载并安装 `Bun`, 也可以直接使用 `npm install -g bun` 安装
+`Bun` 是一个现代的 `JavaScript` / `TypeScript` 运行环境, 本项目基于 `Bun` 环境运行; 请在官网 [bun.sh](https://bun.sh) 下载并安装 `Bun`, 也可以直接使用 `npm install -g bun` 安装
 
 ## 3 安装 `MarkdownPaper`
 
@@ -97,6 +101,7 @@ mdp example.md --outputDOCX
 | `--outputDOCX` | 输出 `DOCX` 文件, 默认不输出<br>**导出后样式可能无法完全保留, 请自行调整** |
 
 # 模板说明
+
 `/theme/theme.ts` 中的 `MarkdownnPaperTheme` 接口定义了模板的样式, 按照类似于 `aps` 文件夹的结构可自定义模板; 模板可以提供自定义功能
 
 模板制作完成后, 在 `/lib/main.ts` 中导入并添加到 `class MarkdownPaperOptions -> constructor -> case '--theme':` 中, 并在下方添加使用文档即可
@@ -104,7 +109,9 @@ mdp example.md --outputDOCX
 推荐所有主题的文档和编写格式都尽量与 `aps` 主题保持一致
 
 ## APS 模板
+
 ### 额外命令行参数
+
 | 参数 | 说明 |
 | :---: | :---: |
 | `--showTitle` | 在页眉显示文件名, 默认不显示 |
@@ -113,9 +120,12 @@ mdp example.md --outputDOCX
 | `--enPunctuation` | 将正文中的中文标点符号替换为英文标点符号, 默认不替换<br>仅替换 `PDF` 和 `DOCX` 文件 |
 
 ### 编写格式
+
 同上
 
 # 更新日志
+
+- `2.5.0` (2025-02-07): 支持分页符
 - `2.4.0` (2024-12-08): 导出 `DOCX` 文件时, 不再依赖 `Python`
 - `2.3.0` (2024-08-31): 支持数学公式
 - `2.2.0` (2024-08-26): 半重构, 优化导入导出, 优化文档

package/bin/mdp-themes.ts

@@ -0,0 +1,20 @@
+#!/usr/bin/env bun
+
+import { Command } from 'commander'
+import { themeLabels } from '../lib/types'
+import { version } from '../package.json'
+
+const program = new Command()
+
+program
+	.name('mdp-themes')
+	.description('MarkdownPaper CLI - 显示所有可用的论文模板')
+	.version(version)
+	.action(() => {
+		console.log('可用的论文模板:')
+		for (const [id, label] of Object.entries(themeLabels)) {
+			console.log(`- ${id} (${label})`)
+		}
+	})
+
+program.parse(process.argv)

package/bin/mdp.ts

@@ -1,37 +1,46 @@
 #!/usr/bin/env bun
 
-import { MarkdownPaperOptions, renderMarkdown } from '../lib/main.ts'
-/** 命令行参数 */
-const args = process.argv.slice(2)
-/** 当前工作目录 */
+import { resolve } from 'node:path'
+import { Command } from 'commander'
+import { render } from '../lib/main'
+import { cliOptions } from '../lib/types'
+import { version } from '../package.json'
+
+const program = new Command()
 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${MarkdownPaperOptions.format}\n`)
-      process.exit(0)
-    }
-    // 解析参数
-    console.log('\n开始生成\n')
-    const options = new MarkdownPaperOptions(args, cwd)
-    // 渲染 markdown
-    await renderMarkdown(options)
-    console.log('生成成功\n')
-  } 
-  catch (e) {
-    if (e instanceof SyntaxError) {
-      console.error(`参数错误, 正确格式:\n${MarkdownPaperOptions.format}\n`)
-    } else if (e instanceof Error) {
-      console.error(`错误:\n${e.message}\n`)
-    }
-  } 
-  finally {
-    process.exit(0)
-  }
-}(args, cwd)
+
+program
+	.name('mdp')
+	.description('MarkdownPaper CLI')
+	.version(version)
+	.argument('<markdown>', 'Markdown文件相对路径')
+	.option('--out <path>', '输出文件相对路径 (默认和Markdown文件相同)')
+	.option('--theme <name>', '论文模板 (默认为心理学报)', 'APS')
+	.option('--html --output-html', '输出HTML文件', false)
+	.option('--docx --output-docx', '输出DOCX文件', false)
+	.option('--hide-footer', '隐藏页脚页码', false)
+	.option('--punctuation <zh/en/origin>', '标点符号格式', 'zh')
+	.command('themes', '显示所有可用的论文模板')
+	.action((markdown, options) => {
+		console.log('开始生成')
+		const src = resolve(cwd, markdown)
+		const out = options.out
+			? resolve(cwd, options.out)
+			: src.replace(/\.md$/, '.pdf')
+		const opts = cliOptions.parse({
+			...options,
+			src,
+			out,
+		})
+		render(opts)
+			.then(() => {
+				console.log('生成成功')
+				process.exit(0)
+			})
+			.catch((error) => {
+				console.error(`生成失败: ${error.message}`)
+				process.exit(1)
+			})
+	})
+
+program.parse(process.argv)

package/biome.json

@@ -0,0 +1,24 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true
+	},
+	"organizeImports": {
+		"enabled": true
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"trailingCommas": "all",
+			"semicolons": "asNeeded",
+			"quoteStyle": "single"
+		}
+	}
+}

package/lib/main.ts

@@ -1,194 +1,50 @@
-import { marked } from 'marked'
-import puppeteer from 'puppeteer'
 import fs from 'node:fs/promises'
-import path from 'node:path'
-import { readFileSync } from 'node:fs'
-import { APS } from '../theme/aps/aps'
-import type { MarkdownPaperTheme } from '../theme/theme'
-import type { PDFOptions } from 'puppeteer'
-import markedKatex from 'marked-katex-extension'
+import { asBlob } from 'html-docx-js-typescript'
 // @ts-ignore
 import katexCss from 'katex/dist/katex.css' with { type: 'text' }
-import { asBlob } from 'html-docx-js-typescript'
-
-/** 应用参数 */
-class MarkdownPaperOptions {
-  /** markdown 文件绝对路径 */
-  src: string
-  /** pdf 文件绝对路径 */
-  out: string
-  /** 是否输出 html */
-  outputHTML: boolean
-  /** 是否输出 docx */
-  outputDOCX: boolean
-  /** 样式 */
-  theme: MarkdownPaperTheme
-  /** 正确格式 */
-  static format = `mdp <markdown> [--options]
-
-    <markdown>:  markdown 文件相对路径
-    --out=<path>:  输出文件相对路径 (默认为 <markdown>)
-    --theme=<name>:  论文模板 (默认为 APS)
-    --outputHTML:  输出 html 文件 (默认不输出)
-    --outputDOCX:  输出 docx 文件 (默认不输出)
-
-    模板的自定义参数见模板说明`
-  /**
-   * 生成应用参数
-   * @param args 命令行参数
-   * @param cwd 当前工作目录
-   */
-  constructor(args: string[], cwd: string) {
-    // 默认参数
-    this.src = ''
-    this.out = ''
-    this.outputHTML = false
-    this.outputDOCX = false
-    this.theme = new APS(args)
-    // 解析路径参数
-    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
-        }
-      }
-    })
-    // 检查参数
-    if (this.out === '') this.out = this.src.replace('.md', '.pdf')
-  }
-}
-
-/**
- * 渲染 markdown
- * @param options 参数
- */
-async function renderMarkdown(
-  options: MarkdownPaperOptions,
-): Promise<void> {
-  // 读取 markdown 文件
-  const raw = await fs.readFile(options.src, { encoding: 'utf-8' })
-  // 生成 html 文件
-  const html = await mdToHtml(raw, options.theme, path.basename(options.src).replace('.md', ''))
-  // 保存 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,
-    options.theme.script
-  )
-  // 保存 html 文件
-  options.outputHTML && await fs.writeFile(options.out.replace('.pdf', '.html'), html)
-  // 保存 docx 文件
-  const docx = await asBlob(html)
-  const docxBuffer = new Uint8Array(docx instanceof Blob ? await docx.arrayBuffer() : docx.buffer)
-  options.outputDOCX && await fs.writeFile(options.out.replace('.pdf', '.docx'), docxBuffer)
-  options.outputDOCX && console.warn('导出的 DOCX 文件可能存在格式丢失, 请手动调整\n')
-}
-
-/**
- * 把 html 转换为 pdf
- * @param html html 字符串, 图片为 base64
- * @param dist pdf 文件绝对路径
- * @param options pdf 参数, 无需设置路径
- * @param script 在网页中要执行的函数
- */
-async function htmlToPdf(html: string, dist: string, options: PDFOptions, script: () => void): Promise<void> {
-  const browser = await puppeteer.launch()
-  const page = await browser.newPage()
-  await page.setContent(html)
-  // 执行脚本
-  await page.evaluate(script)
-  await page.pdf({ path: dist, ...options })
-  await browser.close()
-}
+import { marked } from 'marked'
+import markedKatex from 'marked-katex-extension'
+import puppeteer from 'puppeteer'
+import { type MarkdownPaperOptions, themes } from './types'
 
 /**
- * 把 markdown 转换为 html
- * @param md markdown 字符串
- * @param theme 论文模板
- * @param pageTitle 页面标题
- * @returns html 字符串
+ * 渲染 MarkdownPaper 文档
+ * @param options MarkdownPaper CLI 选项
  */
-async function mdToHtml(
-  md: string,
-  theme: MarkdownPaperTheme,
-  pageTitle: string = 'MarkdownPaper'
-): Promise<string> {
-  // 设置 marked
-  marked.use(markedKatex({ throwOnError: false }))
-  // 预处理 markdown
-  let html = await theme.preParseMarkdown(md)
-  // 转换 markdown 为 html
-  html = `
+export async function render(options: MarkdownPaperOptions): Promise<void> {
+	const theme = await themes[options.theme](options)
+	const markdown = await fs.readFile(options.src, { encoding: 'utf-8' })
+	marked.use(markedKatex({ throwOnError: false }))
+	const html = await theme.preParseHtml(`
     <!DOCTYPE html>
     <html lang="zh-CN">
     <head>
       <meta charset="UTF-8">
-      <title>${pageTitle}</title>
-      <style>${theme.css}</style>
+      <title>MarkdownPaper</title>
+      <style>\n${theme.css}\n</style>
       <style>\n${katexCss}\n</style>
     </head>
     <body>
-      ${await marked(html)}
+      ${await marked(await theme.preParseMarkdown(markdown))}
     </body>
     </html>
-  `
-  // 预处理 html
-  html = await theme.preParseHTML(html)
-  return html
-}
-
-
-export {
-  MarkdownPaperOptions,
-  renderMarkdown,
-  htmlToPdf,
-  mdToHtml,
-  APS
+  `)
+	const browser = await puppeteer.launch()
+	const page = await browser.newPage()
+	await page.setContent(html)
+	await page.evaluate(theme.script)
+	await page.pdf({ path: options.out, ...theme.pdfOptions })
+	const finalHtml = await page.content()
+	if (options.outputHtml) {
+		await fs.writeFile(options.out.replace('.pdf', '.html'), finalHtml)
+	}
+	if (options.outputDocx) {
+		const docx = await asBlob(finalHtml)
+		const docxBuffer = new Uint8Array(
+			docx instanceof Blob ? await docx.arrayBuffer() : docx.buffer,
+		)
+		await fs.writeFile(options.out.replace('.pdf', '.docx'), docxBuffer)
+		console.warn('注意: 导出的Word文件可能存在格式丢失, 请手动调整')
+	}
+	await browser.close()
 }
-export type {
-  MarkdownPaperTheme
-}

package/lib/themes/aps.css

@@ -0,0 +1,164 @@
+* {
+	font-family: "Times", "Times New Roman", "宋体", "SimSun", "华文宋体",
+		"STSong", sans-serif; /* 所有数字和英文字体都用 Times New Roman */
+	line-height: 1.55em; /* 1.5倍行距 */
+	margin: 0;
+}
+
+hr {
+	/* 用作分页符 */
+	page-break-after: always;
+	border: none;
+}
+
+h1 {
+	/* 中文题目: 二号黑体 */
+	font-size: 29px;
+	font-weight: normal;
+	font-family: "黑体", "SimHei", "华文黑体", "STHeiti", sans-serif;
+	text-align: center;
+	margin-bottom: 9px;
+}
+.author {
+	/* 作者姓名: 四号仿宋 */
+	font-size: 18px;
+	font-weight: normal;
+	font-family: "仿宋", "Fangsong", "华文仿宋", "STFangsong", sans-serif;
+	text-align: center;
+	margin-bottom: 3px;
+}
+.school {
+	/* 作者单位: 小五宋体 */
+	font-size: 12px;
+	text-align: center;
+	margin-bottom: 38px;
+}
+.abstract {
+	/* 摘要和关键词: 五号宋体 */
+	font-size: 14px;
+	text-align: justify;
+	padding: 0 28px;
+	&::before {
+		content: "摘　要";
+		font-weight: normal;
+		font-family: "黑体", "SimHei", "华文黑体", "STHeiti", sans-serif;
+		display: inline-block;
+		margin-right: 14px;
+	}
+}
+.keywords {
+	font-size: 14px;
+	margin-bottom: 31px;
+	padding: 0 28px;
+	&::before {
+		content: "关键词";
+		font-weight: normal;
+		font-family: "黑体", "SimHei", "华文黑体", "STHeiti", sans-serif;
+		display: inline-block;
+		margin-right: 14px;
+	}
+}
+
+h2 {
+	/* 一级标题: 四号宋体 */
+	font-size: 18px;
+	font-weight: normal;
+	margin: 7px 0;
+}
+h3 {
+	/* 二级标题: 五号黑体 */
+	font-size: 14px;
+	font-weight: normal;
+	font-family: "黑体", "SimHei", "华文黑体", "STHeiti", sans-serif;
+	margin: 5px 0;
+}
+h4 {
+	/* 三级标题: 五号黑体 */
+	font-size: 14px;
+	font-weight: normal;
+	font-family: "黑体", "SimHei", "华文黑体", "STHeiti", sans-serif;
+	margin: 3px 0;
+}
+
+p {
+	/* 正文: 五号宋体 */
+	font-size: 14px;
+	text-indent: 24px;
+	text-align: justify;
+}
+
+h5 {
+	/* "参考文献": 五号黑体 */
+	font-size: 14px;
+	font-weight: normal;
+	font-family: "黑体", "SimHei", "华文黑体", "STHeiti", sans-serif;
+	text-align: center;
+	margin-bottom: 7px;
+	margin-top: 20px;
+}
+ul,
+ol {
+	/* 参考文献的项目: 小五号宋体 */
+	list-style-type: none;
+	padding: 0;
+	& > li {
+		font-size: 12px;
+		margin: 6px 0;
+		text-align: justify;
+		text-indent: -24px;
+		padding-left: 24px;
+	}
+	& a {
+		text-decoration: none;
+		color: black;
+	}
+}
+
+img {
+	display: block;
+	max-width: 100%;
+	margin: 0 auto;
+	margin-top: 10px;
+}
+
+blockquote,
+blockquote > p {
+	/* 图片和表格的标题: 小五号宋体 */
+	font-size: 12px;
+	font-weight: normal;
+	text-align: center;
+	margin: 0;
+}
+blockquote > p {
+	margin: 6px 0;
+}
+table {
+	/* 表格: 小五号宋体 */
+	font-size: 12px;
+	position: relative;
+	border-top: 1px solid black;
+	border-bottom: 1px solid black;
+	width: 100%;
+	max-width: 100%;
+	margin: 0 auto;
+	margin-bottom: 10px;
+	& th,
+	& td {
+		font-weight: normal;
+	}
+	& thead::after {
+		/* 用来做三线表中间的横线 */
+		content: "";
+		display: block;
+		position: absolute;
+		border-top: 1px solid #00000060;
+		width: 100%;
+	}
+}
+
+b,
+strong {
+	/* 加粗按黑体处理 */
+	font-weight: normal;
+	font-family: "黑体", "SimHei", "华文黑体", "STHeiti", sans-serif;
+}

package/lib/themes/aps.ts

@@ -0,0 +1,97 @@
+import { readFile } from 'node:fs/promises'
+import { resolve } from 'node:path'
+import { type MarkdownPaperTheme, MarkdownPaperThemes } from '../types'
+
+const cssPath = resolve(import.meta.dirname, 'aps.css')
+const cssContent = await readFile(cssPath, 'utf-8')
+
+export const themeAPS: MarkdownPaperTheme = async (args) => {
+	let script: () => void = () => {}
+	if (args.punctuation === 'zh') {
+		script = () => {
+			const nodes = document.querySelectorAll(
+				'body > p, .abstract, .keywords, .author, .school',
+			)
+			// biome-ignore lint/complexity/noForEach: ...
+			nodes.forEach((node) => {
+				let text = node.textContent ?? ''
+				// 替换中英文逗号和句号
+				text = text
+					.replace(/, /g, '，')
+					.replace(/\. /g, '。')
+					.replace(/\.$/, '。')
+				// 替换中英文冒号
+				text = text.replace(/: /g, '：')
+				// 替换中英文分号
+				text = text.replace(/; /g, '；')
+				// 替换中英文感叹号
+				text = text.replace(/! /g, '！').replace(/!$/, '！')
+				// 替换中英文问号
+				text = text.replace(/\? /g, '？').replace(/\?$/, '？')
+				// 替换中英文括号
+				text = text.replace(/ \(/g, '（').replace(/\) /g, '）')
+				// 恢复et al.,
+				text = text
+					.replace(/et al\.，/g, 'et al., ')
+					.replace(/et al。/g, 'et al. ')
+				// 设置新文本
+				node.textContent = text
+			})
+		}
+	} else if (args.punctuation === 'en') {
+		script = () => {
+			const nodes = document.querySelectorAll(
+				'body > p, .abstract, .keywords, .author, .school',
+			)
+			// biome-ignore lint/complexity/noForEach: ...
+			nodes.forEach((node) => {
+				let text = node.textContent ?? ''
+				// 替换中英文逗号和句号
+				text = text.replace(/，/g, ', ').replace(/。 /g, '. ')
+				// 替换中英文冒号
+				text = text.replace(/：/g, ': ')
+				// 替换中英文分号
+				text = text.replace(/；/g, '; ')
+				// 替换中英文感叹号
+				text = text.replace(/！/g, '! ')
+				// 替换中英文问号
+				text = text.replace(/？/g, '? ')
+				// 替换中英文括号
+				text = text.replace(/（/g, ' (').replace(/）/g, ') ')
+				// 设置新文本
+				node.textContent = text
+			})
+		}
+	}
+	return {
+		id: MarkdownPaperThemes.APS,
+		label: '心理学报',
+		css: cssContent,
+		script,
+		preParseMarkdown: async (md: string): Promise<string> => {
+			return md
+				.replace(/#author# (.*)/gm, '<div class="author">$1</div>')
+				.replace(/#school# (.*)/gm, '<div class="school">$1</div>')
+				.replace(/#keywords# (.*)/gm, '<div class="keywords">$1</div>')
+				.replace(/#abstract# (.*)/gm, '<div class="abstract">$1</div>')
+		},
+		preParseHtml: async (html: string): Promise<string> => {
+			// 把包裹图片的 p 标签去掉
+			return html.replace(/<p><img (.*?)><\/p>/g, '<img $1>')
+		},
+		pdfOptions: {
+			format: 'A4',
+			margin: {
+				top: '2cm',
+				right: '2.5cm',
+				bottom: '2cm',
+				left: '2.5cm',
+			},
+			displayHeaderFooter: !args.hideFooter,
+			headerTemplate: '<div></div>',
+			footerTemplate: args.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/lib/types.ts

@@ -0,0 +1,76 @@
+import type { PDFOptions } from 'puppeteer'
+import { z } from 'zod'
+import { themeAPS } from './themes/aps'
+
+/**
+ * MarkdownPaper 主题 ID
+ */
+export enum MarkdownPaperThemes {
+	APS = 'APS',
+}
+
+export const themeLabels: Record<MarkdownPaperThemes, string> = {
+	[MarkdownPaperThemes.APS]: '心理学报',
+}
+
+export const themes: Record<MarkdownPaperThemes, MarkdownPaperTheme> = {
+	[MarkdownPaperThemes.APS]: themeAPS,
+}
+
+/**
+ * MarkdownPaper CLI 选项的 Zod Schema
+ */
+export const cliOptions = z.object({
+	src: z.string(),
+	out: z.string(),
+	theme: z.nativeEnum(MarkdownPaperThemes),
+	outputHtml: z.boolean(),
+	outputDocx: z.boolean(),
+	hideFooter: z.boolean(),
+	punctuation: z.enum(['zh', 'en', 'origin']),
+})
+
+/**
+ * MarkdownPaper CLI 选项 (详见 `bin/mdp.ts`)
+ */
+export type MarkdownPaperOptions = z.infer<typeof cliOptions>
+
+/**
+ * MarkdownPaper 论文模板
+ * @param args 命令行参数, 如果不提供, 则只有效返回 id 和 label 参数
+ */
+export type MarkdownPaperTheme = (args: MarkdownPaperOptions) => Promise<{
+	/**
+	 * 主题ID
+	 */
+	id: MarkdownPaperThemes
+	/**
+	 * 主题名称
+	 */
+	label: string
+	/**
+	 * css 样式
+	 * 不含 \<style>\</style>
+	 */
+	css: string
+	/**
+	 * 预处理 markdown 字符串 (用于转换自定义标签等)
+	 * @param md markdown 字符串
+	 * @returns 转换后的 markdown 字符串
+	 */
+	preParseMarkdown(md: string): Promise<string>
+	/**
+	 * 预处理 html 字符串
+	 * @param html html 字符串
+	 * @returns 转换后的 html 字符串
+	 */
+	preParseHtml(html: string): Promise<string>
+	/**
+	 * 在网页中要执行的函数
+	 */
+	script(): void
+	/**
+	 * PDF 参数 (无需设置路径)
+	 */
+	pdfOptions: PDFOptions
+}>

package/package.json

@@ -1,31 +1,56 @@
 {
-  "name": "markdown-paper",
-  "type": "module",
-  "version": "2.4.0",
-  "author": {
-    "name": "LeafYeeXYZ",
-    "email": "xiaoyezi@leafyee.xyz"
-  },
-  "license": "GPL-3.0-only",
-  "scripts": {
-    "mdp": "bun ./bin/mdp.ts",
-    "pub": "npm publish",
-    "try": "bun mdp ./demo/论文.md --outputHTML --outputDOCX"
-  },
-  "main": "./lib/main.ts",
-  "bin": {
-    "mdp": "./bin/mdp.ts"
-  },
-  "devDependencies": {
-    "@types/bun": "latest"
-  },
-  "peerDependencies": {
-    "typescript": "^5.4.5"
-  },
-  "dependencies": {
-    "html-docx-js-typescript": "^0.1.5",
-    "marked": "^12.0.2",
-    "marked-katex-extension": "^5.1.3",
-    "puppeteer": "^22.15.0"
-  }
-}
+	"name": "markdown-paper",
+	"version": "3.0.0",
+	"author": {
+		"name": "LeafYeeXYZ",
+		"email": "xiaoyezi@leafyee.xyz"
+	},
+	"dependencies": {
+		"commander": "^14.0.0",
+		"html-docx-js-typescript": "^0.1.5",
+		"marked": "^12.0.2",
+		"marked-katex-extension": "^5.1.4",
+		"puppeteer": "^22.15.0",
+		"zod": "^3.25.56"
+	},
+	"peerDependencies": {
+		"typescript": "^5.4.5"
+	},
+	"bin": {
+		"mdp": "bun ./bin/mdp.ts",
+		"mdp-themes": "bun ./bin/mdp-themes.ts"
+	},
+	"license": "GPL-3.0-only",
+	"scripts": {
+		"mdp": "bun ./bin/mdp.ts",
+		"try": "bun mdp ./demo/论文.md --html --docx",
+		"release:create": "commit-and-tag-version",
+		"release:publish": "git push --follow-tags origin main && npm publish",
+		"check": "biome check --write ."
+	},
+	"type": "module",
+	"devDependencies": {
+		"@biomejs/biome": "1.9.4",
+		"commit-and-tag-version": "^12.5.1"
+	},
+	"commit-and-tag-version": {
+		"types": [
+			{
+				"type": "feat",
+				"section": "Features"
+			},
+			{
+				"type": "fix",
+				"section": "Bug Fixes"
+			},
+			{
+				"type": "refactor",
+				"section": "Refactoring"
+			},
+			{
+				"type": "perf",
+				"section": "Improvements"
+			}
+		]
+	}
+}

package/tsconfig.json

@@ -1,27 +1,27 @@
 {
-  "compilerOptions": {
-    // Enable latest features
-    "lib": ["ESNext", "DOM"],
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
+	"compilerOptions": {
+		// Enable latest features
+		"lib": ["ESNext", "DOM"],
+		"target": "ESNext",
+		"module": "ESNext",
+		"moduleDetection": "force",
+		"jsx": "react-jsx",
+		"allowJs": true,
 
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
+		// Bundler mode
+		"moduleResolution": "bundler",
+		"allowImportingTsExtensions": true,
+		"verbatimModuleSyntax": true,
+		"noEmit": true,
 
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
+		// Best practices
+		"strict": true,
+		"skipLibCheck": true,
+		"noFallthroughCasesInSwitch": true,
 
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noPropertyAccessFromIndexSignature": true
-  }
+		// Some stricter flags (disabled by default)
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"noPropertyAccessFromIndexSignature": true
+	}
 }

package/theme/aps/aps.css

@@ -1,137 +0,0 @@
-* {
-  font-family: 'Times', 'Times New Roman', '宋体', 'SimSun', '华文宋体', 'STSong'; /* 所有数字和英文字体都用 Times New Roman */
-  line-height: 1.55em; /* 1.5倍行距 */
-  margin: 0;
-}
-
-h1 { /* 中文题目: 二号黑体 */
-  font-size: 29px;
-  font-weight: normal;
-  font-family: '黑体', 'SimHei', '华文黑体', 'STHeiti';
-  text-align: center;
-  margin-bottom: 9px;
-}
-.author { /* 作者姓名: 四号仿宋 */
-  font-size: 18px;
-  font-weight: normal;
-  font-family: '仿宋', 'Fangsong', '华文仿宋', 'STFangsong';
-  text-align: center;
-  margin-bottom: 3px;
-}
-.school { /* 作者单位: 小五宋体 */
-  font-size: 12px;
-  text-align: center;
-  margin-bottom: 38px;
-}
-.abstract { /* 摘要和关键词: 五号宋体 */
-  font-size: 14px;
-  text-align: justify;
-  padding: 0 28px;
-  &::before { 
-    content: '摘　要';
-    font-weight: normal;
-    font-family: '黑体', 'SimHei', '华文黑体', 'STHeiti';
-    display: inline-block;
-    margin-right: 14px;
-  }
-}
-.keywords { 
-  font-size: 14px;
-  margin-bottom: 31px; 
-  padding: 0 28px;
-  &::before { 
-    content: '关键词';
-    font-weight: normal;
-    font-family: '黑体', 'SimHei', '华文黑体', 'STHeiti';
-    display: inline-block;
-    margin-right: 14px;
-  }
-}
-
-h2 { /* 一级标题: 四号宋体 */
-  font-size: 18px;
-  font-weight: normal;
-  margin: 7px 0;
-}
-h3 { /* 二级标题: 五号黑体 */
-  font-size: 14px;
-  font-weight: normal;
-  font-family: '黑体', 'SimHei', '华文黑体', 'STHeiti';
-  margin: 5px 0;
-}
-h4 { /* 三级标题: 五号黑体 */
-  font-size: 14px;
-  font-weight: normal;
-  font-family: '黑体', 'SimHei', '华文黑体', 'STHeiti';
-  margin: 3px 0;
-}
-
-p { /* 正文: 五号宋体 */
-  font-size: 14px;
-  text-indent: 24px;
-  text-align: justify;
-}
-
-h5 { /* "参考文献": 五号黑体 */
-  font-size: 14px;
-  font-weight: normal;
-  font-family: '黑体', 'SimHei', '华文黑体', 'STHeiti';
-  text-align: center;
-  margin-bottom: 7px;
-  margin-top: 20px;
-}
-ul, ol { /* 参考文献的项目: 小五号宋体 */
-  list-style-type: none;
-  padding: 0;
-  & > li { 
-    font-size: 12px;
-    margin: 6px 0;
-    text-align: justify;
-    text-indent: -24px;
-    padding-left: 24px;
-  }
-  & a {
-    text-decoration: none;
-    color: black;
-  }
-}
-
-img {
-  display: block;
-  max-width: 100%;
-  margin: 0 auto;
-  margin-top: 10px;
-}
-
-blockquote, blockquote > p { /* 图片和表格的标题: 小五号宋体 */
-  font-size: 12px;
-  font-weight: normal;
-  text-align: center;
-  margin: 0;
-}
-blockquote > p { margin: 6px 0; }
-table { /* 表格: 小五号宋体 */
-  font-size: 12px;
-  position: relative;
-  border-top: 1px solid black;
-  border-bottom: 1px solid black;
-  width: 100%;
-  max-width: 100%;
-  margin: 0 auto;
-  margin-bottom: 10px;
-  & th, & td {
-    font-weight: normal;
-  }
-  & thead::after { /* 用来做三线表中间的横线 */
-    content: '';
-    display: block;
-    position: absolute;
-    border-top: 1px solid #00000060;
-    width: 100%;
-  }
-}
-
-b, strong { /* 加粗按黑体处理 */
-  font-weight: normal;
-  font-family: '黑体', 'SimHei', '华文黑体', 'STHeiti';
-}

package/theme/aps/aps.ts

@@ -1,122 +0,0 @@
-import type { MarkdownPaperTheme } from '../theme'
-import type { PDFOptions } from 'puppeteer'
-import fs from 'node:fs'
-import path from 'node:path'
-
-export class APS implements MarkdownPaperTheme {
-
-  css: string
-  preParseMarkdown: (md: string) => Promise<string>
-  preParseHTML: (html: string) => Promise<string>
-  script: () => void
-  pdfOptions: PDFOptions
-
-  constructor(
-    args: string[] = [],
-  ) {
-  
-    // 默认自定义参数
-    let showTitle: boolean = false
-    let hideFooter: boolean = false
-    let zhPunctuation: boolean = false
-    let enPunctuation: boolean = false
-    // 解析参数
-    args.forEach(arg => {
-      switch (arg.split('=')[0]) {
-        case '--showTitle': showTitle = true; break
-        case '--hideFooter': hideFooter = true; break
-        case '--zhPunctuation': zhPunctuation = true; break
-        case '--enPunctuation': enPunctuation = true; break
-      }
-    })
-
-    // css
-    this.css = fs.readFileSync(path.resolve(import.meta.dirname, 'aps.css'), 'utf-8')
-    
-    // preParseMarkdown
-    this.preParseMarkdown = async (md: string): Promise<string> => {
-      // 作者
-      md = md.replace(/#author# (.*)/mg, '<div class="author">$1</div>')
-      // 单位
-      md = md.replace(/#school# (.*)/mg, '<div class="school">$1</div>')
-      // 关键词
-      md = md.replace(/#keywords# (.*)/mg, '<div class="keywords">$1</div>')
-      // 摘要
-      md = md.replace(/#abstract# (.*)/mg, '<div class="abstract">$1</div>')
-      // 返回处理后的字符串
-      return md
-    }
-
-    // preParseHTML
-    this.preParseHTML = async (html: string): Promise<string> => {
-      // 把包裹图片的 p 标签去掉
-      html = html.replace(/<p><img (.*?)><\/p>/g, '<img $1>')
-      // 返回处理后的字符串
-      return html
-    }
-
-    // script
-    // 替换标点
-    if (zhPunctuation && !enPunctuation) {
-      this.script = () => {
-        const nodes = document.querySelectorAll('body > p, .abstract, .keywords, .author, .school')
-        nodes.forEach(node => {
-          let text = node.textContent ?? ''
-          // 替换中英文逗号和句号
-          text = text.replace(/, /g, '，').replace(/\. /g, '。').replace(/\.$/, '。')
-          // 替换中英文冒号
-          text = text.replace(/: /g, '：')
-          // 替换中英文分号
-          text = text.replace(/; /g, '；')
-          // 替换中英文感叹号
-          text = text.replace(/! /g, '！').replace(/!$/, '！')
-          // 替换中英文问号
-          text = text.replace(/\? /g, '？').replace(/\?$/, '？')
-          // 替换中英文括号
-          text = text.replace(/ \(/g, '（').replace(/\) /g, '）')
-          // 恢复et al.,
-          text = text.replace(/et al\.，/g, 'et al., ').replace(/et al。/g, 'et al. ')
-          // 设置新文本
-          node.textContent = text
-        })
-      }
-    } else if (!zhPunctuation && enPunctuation) {
-      this.script = () => {
-        const nodes = document.querySelectorAll('body > p, .abstract, .keywords, .author, .school')
-        nodes.forEach(node => {
-          let text = node.textContent ?? ''
-          // 替换中英文逗号和句号
-          text = text.replace(/，/g, ', ').replace(/。 /g, '. ')
-          // 替换中英文冒号
-          text = text.replace(/：/g, ': ')
-          // 替换中英文分号
-          text = text.replace(/；/g, '; ')
-          // 替换中英文感叹号
-          text = text.replace(/！/g, '! ')
-          // 替换中英文问号
-          text = text.replace(/？/g, '? ')
-          // 替换中英文括号
-          text = text.replace(/（/g, ' (').replace(/）/g, ') ')
-          // 设置新文本
-          node.textContent = text
-        })
-      }
-    } else {
-      this.script = () => {}
-    }
-
-    // pdfOptions
-    this.pdfOptions = { 
-      format: 'A4',
-      margin: { 
-        top: '2cm', 
-        right: '2.5cm', 
-        bottom: '2cm', 
-        left: '2.5cm' 
-      },
-      displayHeaderFooter: showTitle || !hideFooter,
-      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,33 +0,0 @@
-import type { PDFOptions } from 'puppeteer'
-
-export interface MarkdownPaperTheme {
-  /** 
-   * css 样式  
-   * 不含 \<style>\</style> 
-   */
-  css: string
-  /**
-   * 预处理 markdown 字符串  
-   * 用于转换自定义标签等
-   * @param md markdown 字符串
-   * @returns 转换后的 markdown 字符串
-   */
-  preParseMarkdown(md: string): Promise<string>
-  /**
-   * 预处理 html 字符串  
-   * 将在保存 html 文件前调用
-   * @param html html 字符串
-   * @returns 转换后的 html 字符串
-   */
-  preParseHTML(html: string): Promise<string>
-  /**
-   * 在网页中要执行的函数  
-   * 将在保存 html 文件后调用
-   */
-  script(): void
-  /**
-   * PDF 参数  
-   * 无需设置路径
-   */
-  pdfOptions: PDFOptions
-}