Rich Markdown Editor 项目教程

Rich Markdown Editor 项目教程

rich-markdown-editor The open source React and Prosemirror based markdown editor that powers Outline. Want to try it out? Create an account: 项目地址: https://gitcode.com/gh_mirrors/ri/rich-markdown-editor

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

rich-markdown-editor/
├── docs/
│   ├── README.md
│   └── ...
├── src/
│   ├── components/
│   ├── editor/
│   ├── index.tsx
│   └── ...
├── public/
│   ├── index.html
│   └── ...
├── package.json
├── tsconfig.json
└── ...

• docs/: 包含项目的文档文件，如 README.md 等。
• src/: 项目的源代码目录，包含主要的组件和编辑器逻辑。
  • components/: 存放项目的React组件。
  • editor/: 存放编辑器相关的代码。
  • index.tsx: 项目的入口文件。
• public/: 存放静态资源文件，如 index.html。
• package.json: 项目的依赖配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.tsx。这个文件是整个项目的入口点，负责初始化应用并渲染主要的组件。

import React from 'react';
import ReactDOM from 'react-dom';
import Editor from './editor';

ReactDOM.render(<Editor />, document.getElementById('root'));

• ReactDOM.render: 将 Editor 组件渲染到 index.html 中的 root 元素。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本命令和其他元数据。

{
  "name": "rich-markdown-editor",
  "version": "1.0.0",
  "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": {
    "@types/react": "^17.0.3",
    "@types/react-dom": "^17.0.3"
  }
}

• scripts: 定义了项目的启动、构建、测试等命令。
• dependencies: 列出了项目运行时所需的依赖包。
• devDependencies: 列出了开发环境所需的依赖包。

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了 TypeScript 编译器的选项。

{
  "compilerOptions": {
    "target": "es5",
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "forceConsistentCasingInFileNames": true,
    "noFallthroughCasesInSwitch": true,
    "module": "esnext",
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "react-jsx"
  },
  "include": ["src"]
}

• compilerOptions: 定义了 TypeScript 编译器的选项，如目标 ECMAScript 版本、模块系统等。
• include: 指定需要编译的文件或目录。

rich-markdown-editor The open source React and Prosemirror based markdown editor that powers Outline. Want to try it out? Create an account: 项目地址: https://gitcode.com/gh_mirrors/ri/rich-markdown-editor