markdown-react-js 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00710/article/details/142050034

markdown-react-js 项目教程

markdown-react-jsMarkdown to React Component converter项目地址:https://gitcode.com/gh_mirrors/ma/markdown-react-js

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

markdown-react-js/
├── src/
│   ├── components/
│   │   ├── Markdown.js
│   │   └── ...
│   ├── index.js
│   └── ...
├── public/
│   ├── index.html
│   └── ...
├── package.json
├── README.md
└── ...

目录结构介绍

src/: 项目的源代码目录，包含所有React组件和主入口文件。
- components/: 存放React组件的目录，其中Markdown.js是主要的Markdown解析组件。
- index.js: 项目的入口文件，负责渲染React应用。
public/: 存放静态资源文件，如HTML模板等。
- index.html: 项目的HTML模板文件，React应用将渲染到此文件的div元素中。
package.json: 项目的配置文件，包含依赖项、脚本等信息。
README.md: 项目的说明文档，通常包含项目的基本信息和使用说明。

2. 项目的启动文件介绍

index.js

import React from 'react';
import ReactDOM from 'react-dom';
import Markdown from './components/Markdown';

const markdownContent = `# Hello, *world*!`;

ReactDOM.render(
  <Markdown>{markdownContent}</Markdown>,
  document.getElementById('root')
);

启动文件介绍

index.js: 这是项目的入口文件，负责初始化React应用并渲染Markdown组件。
- ReactDOM.render: 将Markdown组件渲染到HTML文件中的root元素中。
- Markdown: 这是主要的Markdown解析组件，负责将Markdown内容转换为React组件。

3. 项目的配置文件介绍

package.json

{
  "name": "markdown-react-js",
  "version": "1.0.0",
  "description": "A simple Markdown parser for React",
  "main": "src/index.js",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3"
  },
  "devDependencies": {
    "eslint": "^7.23.0",
    "eslint-plugin-react": "^7.23.1"
  },
  "browserslist": {
    "production": [
      ">0.2%",
      "not dead",
      "not op_mini all"
    ],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  }
}