Marp Core 开源项目教程

Marp Core 开源项目教程

marp-coreThe core of Marp converter项目地址:https://gitcode.com/gh_mirrors/ma/marp-core

1. 项目的目录结构及介绍

Marp Core 项目的目录结构如下：

marp-core/
├── bin/
├── docs/
├── examples/
├── lib/
├── src/
├── test/
├── .editorconfig
├── .eslintrc.json
├── .gitignore
├── .npmrc
├── .prettierrc
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录介绍

• bin/: 包含可执行文件。
• docs/: 包含项目文档。
• examples/: 包含示例文件。
• lib/: 包含编译后的 JavaScript 文件。
• src/: 包含源代码文件。
• test/: 包含测试文件。
• .editorconfig: 编辑器配置文件。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 变更日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

Marp Core 的启动文件位于 src/index.ts。这个文件是项目的入口点，负责导出主要的功能模块和类。

export { Marp } from './marp'
export { Marpit } from '@marp-team/marpit'
export { default as MarpCLI } from './cli'
export { default as MarpCore } from './marp-core'
export { default as MarpMarkdown } from './markdown'
export { default as MarpTheme } from './theme'
export { default as MarpTransition } from './transition'
export { default as MarpEngine } from './engine'

3. 项目的配置文件介绍

Marp Core 的配置文件主要包括以下几个：

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一些关键部分：

{
  "name": "marp-core",
  "version": "2.0.0",
  "description": "The core of Marp converter",
  "main": "lib/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "@marp-team/marpit": "^2.0.0",
    "markdown-it": "^12.0.0"
  },
  "devDependencies": {
    "@types/jest": "^27.0.0",
    "jest": "^27.0.0",
    "typescript": "^4.0.0"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了编译选项和项目结构。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./lib",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src"]
}

.eslintrc.json

.eslintrc.json 文件是 ESLint 的配置文件，用于代码风格检查。

{
  "parser": "@typescript-eslint/parser",
  "plugins": ["@typescript-eslint"],
  "extends": [
    "eslint:recommended",
    "plugin:@typescript-eslint/recommended"
  ],
  "rules": {
    "no-console": "off"
  }
}

.prettierrc

.prettierrc 文件是 Prettier 的配置文件，用于代码格式化。

{
  "singleQuote": true,
  "trailingComma": "all"

marp-coreThe core of Marp converter项目地址:https://gitcode.com/gh_mirrors/ma/marp-core