markdown-paper 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.1.0](https://github.com/LeafYeeXYZ/MarkdownPaper/compare/v3.0.1...v3.1.0) (2025-06-09)
+
+
+### Features
+
+* 新增导出 ([196dfea](https://github.com/LeafYeeXYZ/MarkdownPaper/commit/196dfea1565f19d42c67e6fb995dd86d6c82aa1f))
+
+## [3.0.1](https://github.com/LeafYeeXYZ/MarkdownPaper/compare/v3.0.0...v3.0.1) (2025-06-09)
+
+
+### Bug Fixes
+
+* 修改在不输入.md时无法识别的问题 ([142daf2](https://github.com/LeafYeeXYZ/MarkdownPaper/commit/142daf25141d2b326d74ebcf0220e028c689e8a5))
+
 ## 3.0.0 (2025-06-09)
 
 

package/README.md

@@ -1,4 +1,4 @@
-以心理学报等学术论文的格式从 Markdown 生成 PDF / HTML / DOCX 文件
+**以心理学报等学术论文的格式从 Markdown 生成 PDF / HTML / DOCX 文件**
 
 # 使用方法
 
@@ -82,65 +82,15 @@ bun add -g markdown-paper
 
 ```bash
 # 查看帮助信息
-mdp
+mdp --help
+# 查看版本信息
+mdp --version
+# 查看可用的论文模板
+mdp themes
 # 从当前工作目录下的 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 文件
-mdp example.md --outputDOCX
+mdp example.md # 可以省略 .md 后缀
 ```
 
-| 参数 | 说明 |
-| :---: | :---: |
-| `--out=xxx` | 输出文件相对路径<br>默认为源文件路径的同名 `PDF` 文件 |
-| `--theme=xxx` | 论文模板, 默认为 `aps` (`Acta Psychologica Sinica`)<br>暂时没有其他模板, 欢迎贡献 |
-| `--outputHTML` | 输出 `HTML` 文件, 默认不输出 |
-| `--outputDOCX` | 输出 `DOCX` 文件, 默认不输出<br>**导出后样式可能无法完全保留, 请自行调整** |
-
 # 模板说明
 
-`/theme/theme.ts` 中的 `MarkdownnPaperTheme` 接口定义了模板的样式, 按照类似于 `aps` 文件夹的结构可自定义模板; 模板可以提供自定义功能
-
-模板制作完成后, 在 `/lib/main.ts` 中导入并添加到 `class MarkdownPaperOptions -> constructor -> case '--theme':` 中, 并在下方添加使用文档即可
-
-推荐所有主题的文档和编写格式都尽量与 `aps` 主题保持一致
-
-## APS 模板
-
-### 额外命令行参数
-
-| 参数 | 说明 |
-| :---: | :---: |
-| `--showTitle` | 在页眉显示文件名, 默认不显示 |
-| `--hideFooter` | 隐藏页码, 默认显示 |
-| `--zhPunctuation` | 将正文中的英文标点符号替换为中文标点符号, 默认不替换<br>仅替换 `PDF` 和 `DOCX` 文件 |
-| `--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): 半重构, 优化导入导出, 优化文档
-- `2.1.1` (2024-07-12): 修复字体错误
-- `2.1.0` (2024-06-26): 支持 `MacOS` 系统, 改为在线加载字体
-- `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): 初版发布
+`/lib/types.ts` 中的 `MarkdownnPaperTheme` 类型定义了论文模板; 模板制作完成后, 在 `/lib/types.ts` 中导入并添加即可使用

package/bin/mdp.ts

@@ -23,7 +23,9 @@ program
 	.command('themes', '显示所有可用的论文模板')
 	.action((markdown, options) => {
 		console.log('开始生成')
-		const src = resolve(cwd, markdown)
+		const src = markdown.endsWith('.md')
+			? resolve(cwd, markdown)
+			: resolve(cwd, `${markdown}.md`)
 		const out = options.out
 			? resolve(cwd, options.out)
 			: src.replace(/\.md$/, '.pdf')

package/lib/index.ts

@@ -0,0 +1,2 @@
+export * from './types'
+export * from './main'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "markdown-paper",
-	"version": "3.0.0",
+	"version": "3.1.0",
 	"author": {
 		"name": "LeafYeeXYZ",
 		"email": "xiaoyezi@leafyee.xyz"
@@ -29,6 +29,7 @@
 		"check": "biome check --write ."
 	},
 	"type": "module",
+	"main": "./lib/index.ts",
 	"devDependencies": {
 		"@biomejs/biome": "1.9.4",
 		"commit-and-tag-version": "^12.5.1"