npm - markdown-paper - Versions diffs - 2.2.1 → 2.2.3 - Mend

markdown-paper 2.2.1 → 2.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/README.md CHANGED Viewed

@@ -84,9 +84,9 @@ mdp example.md --outputDOCX
 | `--outputDOCX` | 输出 `DOCX` 文件, 默认不输出<br>**须先通过 `python` 安装依赖 `pdf2docx`**<br>使用时推荐开启 `--hideFooter` 参数 |
 # 模板说明
-`/theme/theme.ts` 中的 `Theme` 抽象类定义了模板的样式, 按照类似于 `aps` 文件夹的结构可自定义模板; 模板可以提供自定义功能
+`/theme/theme.ts` 中的 `MarkdownnPaperTheme` 接口定义了模板的样式, 按照类似于 `aps` 文件夹的结构可自定义模板; 模板可以提供自定义功能
-模板制作完成后, 在 `/lib/main.ts` 中导入并添加到 `class Options -> constructor -> case '--theme':` 中, 并在下方添加使用文档即可
+模板制作完成后, 在 `/lib/main.ts` 中导入并添加到 `class MarkdownPaperOptions -> constructor -> case '--theme':` 中, 并在下方添加使用文档即可
 推荐所有主题的文档和编写格式都尽量与 `aps` 主题保持一致

package/lib/main.ts CHANGED Viewed

@@ -4,7 +4,7 @@ import fs from 'node:fs/promises'
 import path from 'node:path'
 import { readFileSync } from 'node:fs'
 import { APS } from '../theme/aps/aps'
-import { MarkdownPaperTheme } from '../theme/theme'
+import type { MarkdownPaperTheme } from '../theme/theme'
 import type { PDFOptions } from 'puppeteer'
 /** 应用参数 */
@@ -40,7 +40,7 @@ class MarkdownPaperOptions {
     this.out = ''
     this.outputHTML = false
     this.outputDOCX = false
-    this.theme = new APS(args, cwd)
+    this.theme = new APS(args)
     // 解析路径参数
     if (args.length === 0) throw SyntaxError()
     else args[0] = `--src=${args[0]}`
@@ -90,32 +90,14 @@ class MarkdownPaperOptions {
 /**
  * 渲染 markdown
  * @param options 参数
- * @param rawMarkdown 如果传入此参数, 则不再读取文件
  */
 async function renderMarkdown(
   options: MarkdownPaperOptions,
-  rawMarkdown?: string,
 ): Promise<void> {
   // 读取 markdown 文件
-  const raw = rawMarkdown ?? await fs.readFile(options.src, { encoding: 'utf-8' })
-  // 预处理 markdown
-  const md = await options.theme.preParseMarkdown(raw)
-  // 转换 markdown 为 html
-  let html = `
-    <!DOCTYPE html>
-    <html lang="zh-CN">
-    <head>
-      <meta charset="UTF-8">
-      <title>${path.basename(options.src).replace('.md', '')}</title>
-      <style>${options.theme.css}</style>
-    </head>
-    <body>
-      ${await marked(md)}
-    </body>
-    </html>
-  `
-  // 预处理 html
-  html = await options.theme.preParseHTML(html)
+  const raw = await fs.readFile(options.src, { encoding: 'utf-8' })
+  // 生成 html 文件
+  const html = await mdToHtml(raw, options.theme, path.basename(options.src).replace('.md', ''))
   // 保存 html 文件
   options.outputHTML && await fs.writeFile(options.out.replace('.pdf', '.html'), html)
   // 保存 pdf 文件
@@ -180,10 +162,49 @@ function pdfToDocx(pdfPath: string): Promise<void> {
   })
 }
+/**
+ * 把 markdown 转换为 html
+ * @important 浏览器环境中可用
+ * @param md markdown 字符串
+ * @param theme 论文模板
+ * @param pageTitle 页面标题
+ * @returns html 字符串
+ */
+async function mdToHtml(
+  md: string,
+  theme: MarkdownPaperTheme,
+  pageTitle: string = 'MarkdownPaper'
+): Promise<string> {
+  // 预处理 markdown
+  let html = await theme.preParseMarkdown(md)
+  // 转换 markdown 为 html
+  html = `
+    <!DOCTYPE html>
+    <html lang="zh-CN">
+    <head>
+      <meta charset="UTF-8">
+      <title>${pageTitle}</title>
+      <style>${theme.css}</style>
+    </head>
+    <body>
+      ${await marked(html)}
+    </body>
+    </html>
+  `
+  // 预处理 html
+  html = await theme.preParseHTML(html)
+  return html
+}
 export {
-  MarkdownPaperTheme,
   MarkdownPaperOptions,
   renderMarkdown,
   htmlToPdf,
   pdfToDocx,
+  mdToHtml,
+  APS
+}
+export type {
+  MarkdownPaperTheme
 }

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "markdown-paper",
   "type": "module",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "author": {
     "name": "LeafYeeXYZ",
     "email": "xiaoyezi@leafyee.xyz"

package/theme/aps/aps.ts CHANGED Viewed

@@ -1,9 +1,7 @@
-import { MarkdownPaperTheme } from '../theme'
-import { readFileSync } from 'node:fs'
-import { resolve } from 'node:path'
-import type { PDFOptions } from 'puppeteer-core'
+import type { MarkdownPaperTheme } from '../theme'
+import type { PDFOptions } from 'puppeteer'
-export class APS extends MarkdownPaperTheme {
+export class APS implements MarkdownPaperTheme {
   css: string
   preParseMarkdown: (md: string) => Promise<string>
@@ -11,10 +9,10 @@ export class APS extends MarkdownPaperTheme {
   script: () => void
   pdfOptions: PDFOptions
-  constructor(args: string[], cwd: string) {
-    super(args, cwd)
+  constructor(
+    args: string[] = [],
+  ) {
     // 默认自定义参数
     let showTitle: boolean = false
     let hideFooter: boolean = false
@@ -31,7 +29,145 @@ export class APS extends MarkdownPaperTheme {
     })
     // css
-    this.css = readFileSync(resolve(import.meta.dir, 'aps.css'), 'utf-8')
+    this.css = `
+      * {
+        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';
+      }
+    `
     // preParseMarkdown
     this.preParseMarkdown = async (md: string): Promise<string> => {

package/theme/theme.ts CHANGED Viewed

@@ -1,45 +1,33 @@
 import type { PDFOptions } from 'puppeteer-core'
-export abstract class MarkdownPaperTheme {
-  /**
-   * @param args 命令行参数
-   * @param cwd 当前工作目录
-   */
-  constructor(args?: string[], cwd?: string) {
-    this.args = args ?? []
-    this.cwd = cwd ?? process.cwd()
-  }
-  /** 命令行参数 */
-  args: string[]
-  /** 当前工作目录 */
-  cwd: string
+export interface MarkdownPaperTheme {
   /**
    * css 样式
    * 不含 \<style>\</style>
    */
-  abstract css: string
+  css: string
   /**
    * 预处理 markdown 字符串
    * 用于转换自定义标签等
    * @param md markdown 字符串
    * @returns 转换后的 markdown 字符串
    */
-  abstract preParseMarkdown(md: string): Promise<string>
+  preParseMarkdown(md: string): Promise<string>
   /**
    * 预处理 html 字符串
    * 将在保存 html 文件前调用
    * @param html html 字符串
    * @returns 转换后的 html 字符串
    */
-  abstract preParseHTML(html: string): Promise<string>
+  preParseHTML(html: string): Promise<string>
   /**
    * 在网页中要执行的函数
    * 将在保存 html 文件后调用
    */
-  abstract script(): void
+  script(): void
   /**
    * PDF 参数
    * 无需设置路径
    */
-  abstract pdfOptions: PDFOptions
+  pdfOptions: PDFOptions
 }