# ModellCodes

**Repository Path**: undeadway/modell-codes

## Basic Information

- **Project Name**: ModellCodes
- **Description**: 一个前端文本解析器，包含两种解析方式
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-10-23
- **Last Updated**: 2024-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Chinese

## 关于
这是一个前台富文本编辑器的代码解析器。

## 产物
最终生成 `ModellCodes.js` 和 `HitOn.js` 两个文件。  
ModellCodes.js 能用于浏览器，也可用于node端。

### 安装

#### node端
node 端只要执行`npm install Modellcodes`命令即可。

#### 浏览器
将dist文件夹下的两个文件复制到js目录中，然后将文件引入进网页即可。
```
<script type="text/javascript" src="js/Modellcodes.js"></script>
```

### HitOn
![](./demo/HitOn.jpg)
HitOn是我自己开发的一个类Markdown文本标记语言。  
可以独立于ModellCodes使用。[介绍看这里（中文）](http://codes.waygc.net/Modell/HitOn.helper.html)  
虽然HitOn 可以独立于 ModellCodes 使用，但 ModellCodes 已经包含 HitOn 的实现，所以如果已经下载了 `ModellCodes.js` ，则不用再下载 `HitOn.js` 。  
node 端的 `HitOn` 没有单独创建工程，直接引用 `ModellCodes` 或者将编译好的 `HitOn.js` 导入到工程中即可。

## 旧版本兼容
ModellCodes 维持对旧版本的兼容，但不包含 HitOn 。


# English

# About
This is a parser of rich text editor created by myself.

## Output
The output are the files of `ModellCodes.js` and `HitOn.js`.  
`ModellCodes.js` used on browsers, node side could used as `require("Modellcodes")` immediately.

### Install
#### node side
At the node side, run the command of `npm install Modellcodes`.

#### browser
At the browser, copy the output files of dist folder to script folder.  
```
<script type="text/javascript" src="js/Modellcodes.js"></script>
```

### HitOn

HitOn is a markdown likely text mark language.  
It could used without ModellCodes. [See about here(Chinese)](http://codes.waygc.net/Modell/HitOn.helper.html)  
Although, `HitOn` could used independently, but `ModellCodes.js` has contaned it.