WYMeditor 技术文档

1. 安装指南

环境要求

• jQuery: 版本在 1.4.4 到 2.1.x 之间。
• IE8 支持: 需要 ES5 shims。

安装步骤

1. 通过 Bower 安装:

   bower install wymeditor
   

2. 手动下载:

   • 从 GitHub 仓库 下载最新版本的 WYMeditor。
   • 解压文件并将其放置在项目目录中。

3. 引入文件:

   • 在 HTML 文件中引入 jQuery 和 WYMeditor 的 CSS 及 JS 文件：

     <link rel="stylesheet" href="path/to/wymeditor/wymeditor.css">
     <script src="path/to/jquery.js"></script>
     <script src="path/to/wymeditor/wymeditor.js"></script>
     

2. 项目的使用说明

初始化 WYMeditor

在页面加载完成后，使用以下代码初始化 WYMeditor：

$(document).ready(function() {
    $('.wymeditor').wymeditor();
});

配置选项

WYMeditor 提供了多种配置选项，可以根据需求进行自定义。例如：

$('.wymeditor').wymeditor({
    skin: 'default',
    lang: 'zh',
    stylesheet: 'path/to/custom.css'
});

示例

可以在 在线示例 中查看 WYMeditor 的实际效果。

3. 项目 API 使用文档

初始化

var wym = $('.wymeditor').wymeditor();

方法

• update: 更新编辑器内容。

  wym.update();
  

• html: 获取或设置编辑器内容。

  var content = wym.html();
  wym.html('<p>New content</p>');
  

• destroy: 销毁编辑器实例。

  wym.destroy();
  

事件

• onUpdate: 内容更新时触发。

  wym.onUpdate(function() {
      console.log('Content updated');
  });
  

4. 项目安装方式

通过 Bower 安装

bower install wymeditor

手动下载

从 GitHub 仓库 下载最新版本的 WYMeditor，并将其放置在项目目录中。

引入文件

在 HTML 文件中引入 jQuery 和 WYMeditor 的 CSS 及 JS 文件：

<link rel="stylesheet" href="path/to/wymeditor/wymeditor.css">
<script src="path/to/jquery.js"></script>
<script src="path/to/wymeditor/wymeditor.js"></script>

通过以上步骤，您可以成功安装并使用 WYMeditor 编辑器。