Markdown 转 Medium 项目教程

Markdown 转 Medium 项目教程

markdown-to-mediumPublish markdown to medium项目地址:https://gitcode.com/gh_mirrors/ma/markdown-to-medium

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

markdown-to-medium/
├── src/
│   ├── index.js
│   ├── converter.js
│   └── utils.js
├── .babelrc
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

• src/: 包含项目的主要源代码文件。
  • index.js: 项目的入口文件。
  • converter.js: 负责将 Markdown 转换为 Medium 兼容的 HTML。
  • utils.js: 包含一些辅助函数。
• .babelrc: Babel 配置文件，用于转译 JavaScript 代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。
• package.json: 项目的依赖和脚本配置。
• yarn.lock: 锁定依赖版本的文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。这个文件负责初始化转换器并导出主要功能。以下是 index.js 的简要代码示例：

import { convertMarkdownToMedium } from './converter';

export { convertMarkdownToMedium };

3. 项目的配置文件介绍

• .babelrc: 这个文件配置了 Babel 的转译规则，确保项目可以使用最新的 JavaScript 特性。

{
  "presets": ["@babel/preset-env"]
}

• package.json: 这个文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "markdown-to-medium",
  "version": "1.0.0",
  "description": "A tool to convert markdown format to medium compatible html",
  "main": "src/index.js",
  "scripts": {
    "start": "node src/index.js",
    "build": "babel src -d dist"
  },
  "dependencies": {
    "markdown-it": "^12.0.0"
  },
  "devDependencies": {
    "@babel/cli": "^7.12.0",
    "@babel/core": "^7.12.0",
    "@babel/preset-env": "^7.12.0"
  }
}

通过以上配置，你可以使用 npm start 或 yarn start 来启动项目，使用 npm run build 或 yarn build 来构建项目。

markdown-to-mediumPublish markdown to medium项目地址:https://gitcode.com/gh_mirrors/ma/markdown-to-medium