Markdown to JSX 项目教程
1. 项目的目录结构及介绍
markdown-to-jsx/
├── README.md
├── package.json
├── src/
│ ├── index.js
│ ├── Markdown.js
│ └── ...
├── dist/
│ ├── markdown-to-jsx.js
│ └── markdown-to-jsx.min.js
└── test/
├── index.test.js
└── ...
- README.md: 项目说明文档。
- package.json: 项目依赖和脚本配置文件。
- src/: 源代码目录,包含主要功能实现。
- index.js: 项目入口文件。
- Markdown.js: 核心功能模块。
- dist/: 编译后的文件目录,包含生产环境的代码。
- test/: 测试文件目录,包含单元测试和集成测试。
2. 项目的启动文件介绍
项目的启动文件是 src/index.js
。该文件负责初始化项目并导出主要功能模块 Markdown
。
import React from 'react';
import ReactDOM from 'react-dom';
import Markdown from './Markdown';
const markdown = `# Hello World`;
ReactDOM.render(
<Markdown>{markdown}</Markdown>,
document.getElementById('root')
);
3. 项目的配置文件介绍
项目的配置文件是 package.json
。该文件包含了项目的依赖、脚本命令和其他配置信息。
{
"name": "markdown-to-jsx",
"version": "7.1.3",
"description": "Convert markdown to JSX with ease",
"main": "dist/markdown-to-jsx.js",
"scripts": {
"build": "rollup -c",
"test": "jest"
},
"dependencies": {
"react": "^16.8.0",
"react-dom": "^16.8.0"
},
"devDependencies": {
"jest": "^24.0.0",
"rollup": "^1.0.0"
}
}
- name: 项目名称。
- version: 项目版本。
- description: 项目描述。
- main: 主入口文件。
- scripts: 脚本命令,如
build
和test
。 - dependencies: 生产环境依赖。
- devDependencies: 开发环境依赖。