React Native Markdown Display 使用教程

React Native Markdown Display 使用教程

react-native-markdown-displayReact Native 100% compatible CommonMark renderer项目地址:https://gitcode.com/gh_mirrors/re/react-native-markdown-display

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

react-native-markdown-display/
├── src/
│   ├── lib/
│   │   ├── renderRules.js
│   │   ├── styles.js
│   │   └── index.js
│   ├── components/
│   │   ├── Markdown.js
│   │   └── MarkdownProps.js
│   └── index.js
├── example/
│   ├── App.js
│   ├── index.js
│   └── README.md
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

• src/: 包含项目的主要源代码。
  • lib/: 包含渲染规则和样式文件。
  • components/: 包含主要的Markdown组件。
• example/: 包含示例应用的代码。
• .gitignore: Git忽略文件。
• LICENSE: 项目许可证。
• package.json: 项目依赖和脚本。
• README.md: 项目说明文档。
• yarn.lock: Yarn包管理锁文件。

2. 项目的启动文件介绍

项目的启动文件位于example/目录下：

• index.js: 示例应用的入口文件，负责启动React Native应用。

import {AppRegistry} from 'react-native';
import App from './App';
import {name as appName} from './app.json';

AppRegistry.registerComponent(appName, () => App);

• App.js: 示例应用的主要组件，展示了如何使用react-native-markdown-display组件。

import React from 'react';
import {SafeAreaView, ScrollView, StyleSheet} from 'react-native';
import Markdown from 'react-native-markdown-display';

const markdown = `
# 标题

这是一个示例Markdown文本。
`;

const App = () => {
  return (
    <SafeAreaView style={styles.container}>
      <ScrollView style={styles.scrollContainer}>
        <Markdown>{markdown}</Markdown>
      </ScrollView>
    </SafeAreaView>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
  },
  scrollContainer: {
    padding: 20,
  },
});

export default App;

3. 项目的配置文件介绍

• package.json: 包含了项目的依赖、脚本和其他配置信息。

{
  "name": "react-native-markdown-display",
  "version": "1.0.0",
  "description": "Markdown display component for React Native",
  "main": "src/index.js",
  "scripts": {
    "start": "react-native start",
    "test": "jest"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-native": "^0.64.2",
    "react-native-markdown-display": "^7.0.0"
  },
  "devDependencies": {
    "@babel/core": "^7.14.6",
    "@babel/runtime": "^7.14.6",
    "babel-jest": "^27.0.6",
    "jest": "^27.0.6",
    "react-test-renderer": "^17.0.2"
  },
  "jest": {
    "preset": "react-native"
  }
}

• babel.config.js: Babel配置文件，用于转换ES6+代码。

module.exports = {
  presets: ['module:metro-react-native-babel-preset'],
};

通过以上配置文件，可以启动和测试项目，并确保代码的正确转换和运行。

react-native-markdown-displayReact Native 100% compatible CommonMark renderer项目地址:https://gitcode.com/gh_mirrors/re/react-native-markdown-display