代码功能更新

This commit is contained in:
root
2025-05-18 07:42:27 +00:00
parent 7fc1d422a1
commit 4a90c41da2
2083 changed files with 695218 additions and 3 deletions
+1
View File
@@ -0,0 +1 @@
!.gitignore
+80
View File
@@ -0,0 +1,80 @@
<?php
namespace plugin\apidoc\controller;
use laytp\controller\Backend;
use laytp\library\CommonFun;
use laytp\library\UploadDomain;
class Index extends Backend
{
/**
* apidoc模型对象
* @var \plugin\devtool\model\Apidoc
*/
protected $model;
public $hasSoftDel = 1;//是否拥有软删除功能
protected $noNeedLogin = ['getMenu'];
public function initialize()
{
parent::initialize();
$this->model = new \plugin\apidoc\model\Apidoc();
}
//添加
public function add()
{
$post = CommonFun::filterPostData($this->request->post());
$post['des'] = UploadDomain::delUploadDomain($post['des']);
if ($this->model->create($post)) {
return $this->success('添加成功', $post);
} else {
return $this->error('操作失败');
}
}
//编辑
public function edit()
{
$id = $this->request->param('id');
$info = $this->model->find($id);
$post = CommonFun::filterPostData($this->request->post());
$post['des'] = UploadDomain::delUploadDomain($post['des']);
foreach ($post as $k => $v) {
$info->$k = $v;
}
try {
$updateRes = $info->save();
if ($updateRes) {
return $this->success('编辑成功');
} else if ($updateRes === 0) {
return $this->success('未做修改');
} else if ($updateRes === null) {
return $this->error('操作失败');
}
} catch (\Exception $e) {
return $this->error('数据库异常,操作失败');
}
}
//生成常规CURD
public function create()
{
$api = new \plugin\apidoc\library\Apidoc();
if ($api->execute('api文档')) {
return $this->success('生成成功');
} else {
return $this->error($api->getError());
}
}
// 获取文档菜单接口
public function getMenu()
{
$menuOutputFile = app()->getRootPath() . 'public' . DS . 'static' . DS . 'admin' . DS . 'data' . DS . 'apidocMenu.json';
$menuJson = file_get_contents($menuOutputFile);
$menu = json_decode($menuJson, true);
return $this->success('生成成功', $menu);
}
}
@@ -0,0 +1,164 @@
<?php
use think\migration\Migrator;
class PluginApiDoc extends Migrator
{
public function change()
{
$table = $this->table('plugin_apidoc', [
'engine' => 'InnoDB',
'comment' => 'Api文档',
'collation' => 'utf8mb4_general_ci',
]);
//删除表
if ($table->exists()) {
$table->drop();
}
$table
->addColumn('title', 'string', ['limit' => 255, 'default' => '', 'comment' => '标题'])
->addColumn('des', 'text', ['comment' => '描述'])
->addColumn('create_time', 'datetime', ['null' => 1, 'comment' => '创建时间'])
->addColumn('update_time', 'datetime', ['null' => 1, 'comment' => '更新时间'])
->addColumn('delete_time', 'datetime', ['null' => 1, 'comment' => '删除时间'])
;
$data = [
[
'title' => '文档更新',
'des' => '本文档分为两个部分,`全局说明文档`和`其他文档`。
# 全局说明文档
全局说明下的文档在后台生成Api文档菜单中进行添加,添加完成后点击生成Api文档按钮即可在本文档中看见
# 其他文档
其他文档使用PHP程序,通过PHP的类反射机制,获取到`app/controller/api/`目录下所有文件的注解来进行生成。
注解规则请查阅`laytp.com`官网手册或者框架`app/controller/api/Demo.php`文件。
如果后端程序员更新了`api`接口程序,并且使用了相应的注解规则,在后台点击`生成Api文档`按钮即可在本文档看到最新的Api文档
# 注意点
由于文档使用的是静态html展示,而浏览器对html页面是有缓存的。所以如果文档进行了更新。可能需要强制刷新页面才能看到最新的文档。',
'create_time' => date('Y-m-d H:i:s'),
'update_time' => date('Y-m-d H:i:s'),
],
[
'title' => '在线测试功能使用',
'des' => '本文档使用`Laytp极速后台开发框架 - 生成Api文档插件`进行生成。
如果需要使用本文档的在线测试功能,需要先进行Api文档配置。
### Api文档配置
点击本文档右上角配置图标会弹出配置层。
配置项包括:Api请求域名、签名开关、Header参数。
#### Api请求域名
后台使用单域名部署模式,则无需修改,使用默认值即可。
后台使用多域名部署模式,则后端程序员需要提供请求Api的域名地址。使用者不要以/结尾,将请求Api的域名地址填入此处
#### 签名开关
请求Api有签名中间件,签名中间件是否启用要根据后台[系统配置 - 基础配置 - Api签名开关]是否开启的配置来决定。如果后台配置[Api签名开关]开启了,此处也要开启。此处开启后,使用本文档的在线测试功能时,在ajax请求头部会自动添加request-time和sign两个参数。至于签名具体如何生成,请查阅[签名相关]章节说明
#### Header参数
此处填入后端程序员自定义的请求头部参数。框架自定义的请求头部参数有用户登录凭证token,请求时间戳request-time,签名sign三个。一个复杂的系统,一般还会在Header头部定义一些公用参数。比如平台标识,代理标识等等。这些公用参数根据需求不同由后端程序员定义,在使用本文档时,自行在此处进行添加
### 配置保存
点击保存按钮,或者点击页面阴影部分遮罩层,配置都会进行保存
### 配置持久化
Api文档配置使用的是localStorage存储在浏览器端进行持久化的。无需担心页面关闭后,配置不存在的问题',
'create_time' => date('Y-m-d H:i:s'),
'update_time' => date('Y-m-d H:i:s'),
],
[
'title' => '统一说明',
'des' => '# 请求方式
默认使用POST方式进行请求
# 请求头Content-Type
请求头的Content-Type定义请求参数的数据类型。ThinkPHP6兼容多种常用请求头方式。比如`application/json`、`application/form-data`和 `application/x-www-form-urlencoded`。
一般的接口,客户端可以使用`application/json`,自行将参数定义成`json`格式进行参数传递。
文件上传不支持`json`方式上传文件`Base64`内容,需要使用提交表单方式上传文件。
# 接口域名
- 正式环境
由后端程序员提供
- 测试环境
由后端程序员提供
# 后台地址
- 正式环境
- 访问地址
由后端程序员提供
- 账号
admin
- 密码
123456
- 测试环境
- 访问地址
由后端程序员提供
- 账号
admin
- 密码
123456',
'create_time' => date('Y-m-d H:i:s'),
'update_time' => date('Y-m-d H:i:s'),
],
[
'title' => '签名相关',
'des' => '客户端请求Api接口程序,后端有签名中间件对请求进行拦截。
签名中间件是否启用要根据后台[系统配置 - 基础配置 - Api签名开关]是否开启的配置来决定。
如果后台配置[Api签名开关]开启了,那么客户端在请求Api接口时,需要在Header部分传递两个参数`request-time`和`sign`。
`request-time`的值由客户端自行定义为当前Unix时间戳。
`sign`的值由签名生成规则计算生成。
# 签名生成规则
- 客户端自行定义request-time的值为当前Unix时间戳,并经过`md5`运算得到`stringA`
- 后台系统配置 - 基础配置 - Api签名Key的值为生成签名的Key,并经过`md5`运算得到`stringB`
- 连接`stringA`和`stringB`后经过`md5`运算得到`stringC`
- 最后将`stringC`全部转成大写即是客户端需要在请求头部分传递的`sign`值',
'create_time' => date('Y-m-d H:i:s'),
'update_time' => date('Y-m-d H:i:s'),
],
[
'title' => '接口返回',
'des' => '接口统一返回`json`格式的数据。
# 返回说明
|参数名|必然存在|类型|说明|
|:---- |:---|:----- |----- |
|code |是 |integer |接口返回码.0=常规正确码,表示常规操作成功;1=常规错误码,客户端仅需提示message;其他返回码与具体业务相关。框架实现了的唯一其他返回码:10401,前端需要跳转至登录界面。在一个复杂的交互过程中,你可能需要自行定义其他返回码|
|msg |是 |string | 接口返回文字描述 |
|time |是 |integer | 接口返回时间戳,单位秒 |
|data |是 |object/array | 附加数据。单条数据是对象,多条数据是数组。当为空时,会返回一个空对象{}|
# 返回示例
```
{
"code":1,
"msg":"签名错误",
"time":1613628412,
"data":{}
}
```',
'create_time' => date('Y-m-d H:i:s'),
'update_time' => date('Y-m-d H:i:s'),
],
];
$table->setData($data)->create();
}
}
+8
View File
@@ -0,0 +1,8 @@
name = apidoc
title = 生成Api文档
description = 根据Api接口注释,生成Api文档。支持签名验证,在线测试。
version = 1.0.3
author = Laytp官方
lt_version = 3.0.0
parent_menu = first
menu_ids = 102,103,104,105,106,107,108,109,110,111
+187
View File
@@ -0,0 +1,187 @@
<?php
namespace plugin\apidoc\library;
use app\service\ConfServiceFacade;
use laytp\traits\Error;
use plugin\apidoc\library\apidoc\library\Builder;
use plugin\apidoc\library\apidoc\library\Extractor;
use laytp\library\DirFile;
use think\facade\Env;
use think\facade\View;
class Apidoc
{
use Error;
protected $template = 'index.html';
protected $output = 'api.html';
protected $force = true;
/**
* 执行生成程序
* @param $title
* @return bool
* @throws \think\db\exception\DataNotFoundException
* @throws \think\db\exception\DbException
* @throws \think\db\exception\ModelNotFoundException
*/
public function execute($title)
{
// $addon = $input->getOption('addon');
// if($addon){
// $addon_service = new Addons();
// $addon_info = $addon_service->_info->getPluginInfo($addon);
// $controllerDir = Env::get('root_path') . DS . 'addons' . DS . $addon . DS . $addon_info['api_module'] . DS;
// }else{
$controllerDir = app()->getRootPath() . DS . 'app' . DS . 'controller' . DS . 'api' . DS;
// }
$files = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator($controllerDir), \RecursiveIteratorIterator::LEAVES_ONLY
);
$weighs = [];
$k = 0;
foreach ($files as $name => $file) {
if (!$file->isDir()) {
$filePath = $file->getRealPath();
$className = $this->getClassFromFile($filePath);
$classAnnotations = Extractor::getClassAnnotations($className);
if (isset($classAnnotations['ApiInternal'])) {
continue;
}
$weigh = isset($classAnnotations['ApiWeigh']) ? intval($classAnnotations['ApiWeigh'][0]) : $k;
$weighs[$this->getClassFromFile($filePath)] = $weigh;
$k++;
}
}
uasort($weighs, function ($a, $b) {
if ($a == $b) return 0;
return ($a > $b) ? -1 : 1;
});
$classes = array_flip($weighs);
$builder = new Builder($classes);
$apiDir = __DIR__ . DS . 'apidoc' . DS;
$templateDir = $apiDir . 'template' . DS;
$templateFile = $templateDir . $this->template;
$var['plugin'] = '';
$var['title'] = $title;
$var['apiDomain'] = Env::get('domain.api');
$var['createSignKey'] = ConfServiceFacade::get('system.basic.signKey');
$var['apidocList'] = \plugin\apidoc\model\Apidoc::select()->toArray();
// $content = $builder->render($templateFile, $var);
$docslist = $builder->render($templateFile, $var);
$menu = [];
$menu[] = [
'id' => 0,
'title' => '全局说明',
'docType' => 'meditor'
];
$key = 0;
foreach($var['apidocList'] as $k=>$v){
$key++;
$temp = [];
$temp['id'] = $key;
$temp['title'] = $v['title'];
$temp['docType'] = 'meditor';
$menu[0]['children'][] = $temp;
}
foreach($docslist as $k=>$v){
$key++;
$temp = [];
$temp['id'] = $key;
$temp['title'] = $k;
$temp['docType'] = 'api';
foreach($v as $api){
$key++;
$children = [];
$children['id'] = $key;
$children['title'] = $api['title'];
$children['docType'] = 'api';
$temp['children'][] = $children;
}
$menu[] = $temp;
}
$menuOutputFile = app()->getRootPath() . 'public' . DS . 'static' . DS . 'admin' . DS . 'data' . DS . 'apidocMenu.json';
file_put_contents($menuOutputFile, json_encode($menu, JSON_UNESCAPED_UNICODE));
View::engine()->layout(false);
$content = View::display(file_get_contents($templateFile), array_merge($var, ['docslist' => $docslist]));
$outputDir = app()->getRootPath() . DS . 'public' . DS;
$outputFile = $outputDir . $this->output;
DirFile::createDir(dirname($outputFile));
if (!file_put_contents($outputFile, $content)) {
$this->setError('Cannot save the content to ' . $outputFile);
return false;
}
return true;
}
/**
* get full qualified class name
*
* @param string $path_to_file
* @return string
* @author JBYRNE http://jarretbyrne.com/2015/06/197/
*/
protected function getClassFromFile($path_to_file)
{
//Grab the contents of the file
$contents = file_get_contents($path_to_file);
//Start with a blank namespace and class
$namespace = $class = "";
//Set helper values to know that we have found the namespace/class token and need to collect the string values after them
$getting_namespace = $getting_class = false;
//Go through each token and evaluate it as necessary
foreach (token_get_all($contents) as $token) {
//If this token is the namespace declaring, then flag that the next tokens will be the namespace name
if (is_array($token) && $token[0] == T_NAMESPACE) {
$getting_namespace = true;
}
//If this token is the class declaring, then flag that the next tokens will be the class name
if (is_array($token) && $token[0] == T_CLASS) {
$getting_class = true;
}
//While we're grabbing the namespace name...
if ($getting_namespace === true) {
//If the token is a string or the namespace separator...
if (is_array($token) && in_array($token[0], [T_STRING, T_NS_SEPARATOR])) {
//Append the token's value to the name of the namespace
$namespace .= $token[1];
} else if ($token === ';') {
//If the token is the semicolon, then we're done with the namespace declaration
$getting_namespace = false;
}
}
//While we're grabbing the class name...
if ($getting_class === true) {
//If the token is a string, it's the name of the class
if (is_array($token) && $token[0] == T_STRING) {
//Store the token's value as the class name
$class = $token[1];
//Got what we need, stope here
break;
}
}
}
//Build the fully-qualified class name and return it
return $namespace ? $namespace . '\\' . $class : $class;
}
}
@@ -0,0 +1,209 @@
<?php
namespace plugin\apidoc\library\apidoc\library;
use think\facade\View;
/**
* @website https://github.com/calinrada/php-apidoc
* @author Calin Rada <rada.calin@gmail.com>
* @author Karson <karsonzhang@163.com>
*/
class Builder
{
/**
*
* @var \think\View
*/
public $view = null;
/**
* parse classes
* @var array
*/
protected $classes = [];
/**
*
* @param array $classes
*/
public function __construct($classes = [])
{
$this->classes = array_merge($this->classes, $classes);
}
protected function extractAnnotations()
{
$st_output = [];
foreach ($this->classes as $class) {
$st_output[] = Extractor::getAllClassAnnotations($class);
}
return end($st_output);
}
protected function generateHeadersTemplate($docs)
{
if (!isset($docs['ApiHeaders'])) {
return [];
}
$headerslist = [];
foreach ($docs['ApiHeaders'] as $params) {
$tr = [
'name' => $params['name'],
'type' => $params['type'],
'sample' => isset($params['sample']) ? $params['sample'] : '',
'required' => isset($params['required']) ? $params['required'] : false,
'description' => isset($params['description']) ? $params['description'] : '',
];
$headerslist[] = $tr;
}
return $headerslist;
}
protected function generateParamsTemplate($docs)
{
if (!isset($docs['ApiParams'])) {
return [];
}
$paramslist = [];
foreach ($docs['ApiParams'] as $params) {
$tr = [
'name' => $params['name'],
'type' => isset($params['type']) ? $params['type'] : 'string',
'sample' => isset($params['sample']) ? $params['sample'] : '',
'required' => isset($params['required']) ? $params['required'] : true,
'description' => isset($params['description']) ? $params['description'] : '',
];
$paramslist[] = $tr;
}
return $paramslist;
}
protected function generateReturnHeadersTemplate($docs)
{
if (!isset($docs['ApiReturnHeaders'])) {
return [];
}
$headerslist = [];
foreach ($docs['ApiReturnHeaders'] as $params) {
$tr = [
'name' => $params['name'],
'type' => 'string',
'sample' => isset($params['sample']) ? $params['sample'] : '',
'required' => isset($params['required']) && $params['required'] ? 'Yes' : 'No',
'description' => isset($params['description']) ? $params['description'] : '',
];
$headerslist[] = $tr;
}
return $headerslist;
}
protected function generateReturnParamsTemplate($st_params)
{
if (!isset($st_params['ApiReturnParams'])) {
return [];
}
$paramslist = [];
foreach ($st_params['ApiReturnParams'] as $params) {
$tr = [
'name' => $params['name'],
'type' => isset($params['type']) ? $params['type'] : 'string',
'sample' => isset($params['sample']) ? $params['sample'] : '',
'description' => isset($params['description']) ? $params['description'] : '',
];
$paramslist[] = $tr;
}
return $paramslist;
}
protected function generateBadgeForMethod($data)
{
$method = strtoupper(is_array($data['ApiMethod'][0]) ? $data['ApiMethod'][0]['data'] : $data['ApiMethod'][0]);
$labes = [
'POST' => 'label-primary',
'GET' => 'label-success',
'PUT' => 'label-warning',
'DELETE' => 'label-danger',
'PATCH' => 'label-default',
'OPTIONS' => 'label-info',
];
return isset($labes[$method]) ? $labes[$method] : $labes['GET'];
}
public function parse()
{
$annotations = $this->extractAnnotations();
$counter = 0;
$section = null;
$docslist = [];
foreach ($annotations as $class => $methods) {
foreach ($methods as $name => $docs) {
if (isset($docs['ApiSector'][0])) {
$section = is_array($docs['ApiSector'][0]) ? $docs['ApiSector'][0]['data'] : $docs['ApiSector'][0];
} else {
$section = $class;
}
if (0 === count($docs)) {
continue;
}
$docslist[$section][] = [
'id' => $counter,
'title' => $docs['ApiTitle'][0],
'method' => is_array($docs['ApiMethod'][0]) ? $docs['ApiMethod'][0]['data'] : $docs['ApiMethod'][0],
'method_label' => $this->generateBadgeForMethod($docs),
'section' => $section,
'route' => is_array($docs['ApiRoute'][0]) ? $docs['ApiRoute'][0]['data'] : $docs['ApiRoute'][0],
'summary' => is_array($docs['ApiSummary'][0]) ? $docs['ApiSummary'][0]['data'] : $docs['ApiSummary'][0],
'body' => isset($docs['ApiBody'][0]) ? is_array($docs['ApiBody'][0]) ? $docs['ApiBody'][0]['data'] : $docs['ApiBody'][0] : '',
'headerslist' => $this->generateHeadersTemplate($docs),
'paramslist' => $this->generateParamsTemplate($docs),
'returnheaderslist' => $this->generateReturnHeadersTemplate($docs),
'returnparamslist' => $this->generateReturnParamsTemplate($docs),
'return' => isset($docs['ApiReturn']) ? is_array($docs['ApiReturn'][0]) ? $docs['ApiReturn'][0]['data'] : $docs['ApiReturn'][0] : '',
];
$counter++;
}
}
return $docslist;
}
public function getView()
{
return $this->view;
}
/**
* 渲染
* @param $template
* @param array $vars
* @return array|string
*/
public function render($template, $vars = [])
{
$docslist = $this->parse();
$ids = [];
foreach ($docslist as $v) {
foreach ($v as $api) {
$ids[] = $api['id'];
}
}
return $docslist;
return View::display(file_get_contents($template), array_merge($vars, ['docslist' => $docslist, 'ids' => json_encode($ids)]));
}
}
@@ -0,0 +1,510 @@
<?php
namespace plugin\apidoc\library\apidoc\library;
use Exception;
/**
* Class imported from https://github.com/eriknyk/Annotations
* @author Erik Amaru Ortiz https://github.com/eriknyk
*
* @license http://opensource.org/licenses/bsd-license.php The BSD License
* @author Calin Rada <rada.calin@gmail.com>
*/
class Extractor
{
/**
* Static array to store already parsed annotations
* @var array
*/
private static $annotationCache;
/**
* Indicates that annotations should has strict behavior, 'false' by default
* @var boolean
*/
private $strict = false;
/**
* Stores the default namespace for Objects instance, usually used on methods like getMethodAnnotationsObjects()
* @var string
*/
public $defaultNamespace = '';
/**
* Sets strict variable to true/false
* @param bool $value boolean value to indicate that annotations to has strict behavior
*/
public function setStrict($value)
{
$this->strict = (bool)$value;
}
/**
* Sets default namespace to use in object instantiation
* @param string $namespace default namespace
*/
public function setDefaultNamespace($namespace)
{
$this->defaultNamespace = $namespace;
}
/**
* Gets default namespace used in object instantiation
* @return string $namespace default namespace
*/
public function getDefaultAnnotationNamespace()
{
return $this->defaultNamespace;
}
/**
* Gets all anotations with pattern @SomeAnnotation() from a given class
*
* @param string $className class name to get annotations
* @return array self::$annotationCache all annotated elements
*/
public static function getClassAnnotations($className)
{
if (!isset(self::$annotationCache[$className])) {
$class = new \ReflectionClass($className);
self::$annotationCache[$className] = self::parseAnnotations($class->getDocComment());
}
return self::$annotationCache[$className];
}
public static function getAllClassAnnotations($className)
{
$class = new \ReflectionClass($className);
foreach ($class->getMethods() as $object) {
self::$annotationCache['annotations'][$className][$object->name] = self::getMethodAnnotations($className, $object->name);
}
return self::$annotationCache['annotations'];
}
/**
* Gets all anotations with pattern @SomeAnnotation() from a determinated method of a given class
*
* @param string $className class name
* @param string $methodName method name to get annotations
* @return array self::$annotationCache all annotated elements of a method given
*/
public static function getMethodAnnotations($className, $methodName)
{
if (!isset(self::$annotationCache[$className . '::' . $methodName])) {
try {
$method = new \ReflectionMethod($className, $methodName);
$class = new \ReflectionClass($className);
if ($className == $method->class) {
if (!$method->isPublic() || $method->isConstructor()) {
$annotations = [];
} else {
$annotations = self::consolidateAnnotations($method, $class);
}
} else {
$annotations = [];
}
} catch (\ReflectionException $e) {
$annotations = [];
}
self::$annotationCache[$className . '::' . $methodName] = $annotations;
}
return self::$annotationCache[$className . '::' . $methodName];
}
/**
* Gets all anotations with pattern @SomeAnnotation() from a determinated method of a given class
* and instance its abcAnnotation class
*
* @param string $className class name
* @param string $methodName method name to get annotations
* @return array self::$annotationCache all annotated objects of a method given
*/
public function getMethodAnnotationsObjects($className, $methodName)
{
$annotations = $this->getMethodAnnotations($className, $methodName);
$objects = [];
$i = 0;
foreach ($annotations as $annotationClass => $listParams) {
$annotationClass = ucfirst($annotationClass);
$class = $this->defaultNamespace . $annotationClass . 'Annotation';
// verify is the annotation class exists, depending if Annotations::strict is true
// if not, just skip the annotation instance creation.
if (!class_exists($class)) {
if ($this->strict) {
throw new Exception(sprintf('Runtime Error: Annotation Class Not Found: %s', $class));
} else {
// silent skip & continue
continue;
}
}
if (empty($objects[$annotationClass])) {
$objects[$annotationClass] = new $class();
}
foreach ($listParams as $params) {
if (is_array($params)) {
foreach ($params as $key => $value) {
$objects[$annotationClass]->set($key, $value);
}
} else {
$objects[$annotationClass]->set($i++, $params);
}
}
}
return $objects;
}
private static function consolidateAnnotations($method, $class)
{
$dockblockClass = $class->getDocComment();
$docblockMethod = $method->getDocComment();
$methodName = $method->getName();
$methodAnnotations = self::parseAnnotations($docblockMethod);
$classAnnotations = self::parseAnnotations($dockblockClass);
if (isset($methodAnnotations['ApiInternal']) || $methodName == '_initialize' || $methodName == '_empty') {
return [];
}
$properties = $class->getDefaultProperties();
$noNeedLogin = isset($properties['noNeedLogin']) ? is_array($properties['noNeedLogin']) ? $properties['noNeedLogin'] : [$properties['noNeedLogin']] : [];
$noNeedRight = isset($properties['noNeedRight']) ? is_array($properties['noNeedRight']) ? $properties['noNeedRight'] : [$properties['noNeedRight']] : [];
preg_match_all("/\*[\s]+(.*)(\\r\\n|\\r|\\n)/U", str_replace('/**', '', $docblockMethod), $methodArr);
preg_match_all("/\*[\s]+(.*)(\\r\\n|\\r|\\n)/U", str_replace('/**', '', $dockblockClass), $classArr);
$methodTitle = isset($methodArr[1]) && isset($methodArr[1][0]) ? $methodArr[1][0] : '';
$classTitle = isset($classArr[1]) && isset($classArr[1][0]) ? $classArr[1][0] : '';
if (!isset($methodAnnotations['ApiMethod'])) {
$methodAnnotations['ApiMethod'] = ['get'];
}
if (!isset($methodAnnotations['ApiSummary'])) {
$methodAnnotations['ApiSummary'] = [$methodTitle];
}
if ($methodAnnotations) {
foreach ($classAnnotations as $name => $valueClass) {
if (count($valueClass) !== 1) {
continue;
}
if ($name === 'ApiRoute') {
if (isset($methodAnnotations[$name])) {
$methodAnnotations[$name] = [rtrim($valueClass[0], '/') . $methodAnnotations[$name][0]];
} else {
$methodAnnotations[$name] = [rtrim($valueClass[0], '/') . '/' . $method->getName()];
}
}
if ($name === 'ApiSector') {
$methodAnnotations[$name] = $valueClass;
}
}
}
if (!isset($methodAnnotations['ApiTitle'])) {
$methodAnnotations['ApiTitle'] = [$methodTitle];
}
if (!isset($methodAnnotations['ApiRoute'])) {
$urlArr = [];
$className = $class->getName();
list($prefix, $suffix) = explode('\\controller\\', $className);
$prefixArr = explode('\\', $prefix);
$suffixArr = explode('\\', $suffix);
if ($prefixArr[0] == 'app') {
$prefixArr[0] = '';
} else if ($prefixArr[0] == 'plugin') {
$tempPrefixArr = [];
$tempPrefixArr[0] = '';
$tempPrefixArr[1] = $prefixArr[2];
$prefixArr = $tempPrefixArr;
}
$urlArr = array_merge($urlArr, $prefixArr);
$urlArr[] = implode('.', array_map(function ($item) {
return self::parseName($item);
}, $suffixArr));
$urlArr[] = $method->getName();
$methodAnnotations['ApiRoute'] = [implode('/', $urlArr)];
}
if (!isset($methodAnnotations['ApiSector'])) {
$methodAnnotations['ApiSector'] = isset($classAnnotations['ApiSector']) ? $classAnnotations['ApiSector'] : [$classTitle];
}
if (!isset($methodAnnotations['ApiParams'])) {
$params = self::parseCustomAnnotations($docblockMethod, 'param');
foreach ($params as $k => $v) {
$arr = explode(' ', preg_replace("/[\s]+/", " ", $v));
$methodAnnotations['ApiParams'][] = [
'name' => isset($arr[1]) ? str_replace('$', '', $arr[1]) : '',
'nullable' => false,
'type' => isset($arr[0]) ? $arr[0] : 'string',
'description' => isset($arr[2]) ? $arr[2] : '',
];
}
}
$methodAnnotations['ApiPermissionLogin'] = [!in_array('*', $noNeedLogin) && !in_array($methodName, $noNeedLogin)];
$methodAnnotations['ApiPermissionRight'] = [!in_array('*', $noNeedRight) && !in_array($methodName, $noNeedRight)];
return $methodAnnotations;
}
/**
* 字符串命名风格转换
* type 0 将Java风格转换为C的风格 1 将C风格转换为Java的风格
* @access public
* @param string $name 字符串
* @param integer $type 转换类型
* @param bool $ucfirst 首字母是否大写(驼峰规则)
* @return string
*/
private static function parseName($name, $type = 0, $ucfirst = true)
{
if ($type) {
$name = preg_replace_callback('/_([a-zA-Z])/', function ($match) {
return strtoupper($match[1]);
}, $name);
return $ucfirst ? ucfirst($name) : lcfirst($name);
}
return strtolower(trim(preg_replace("/[A-Z]/", "_\\0", $name), "_"));
}
/**
* Parse annotations
*
* @param string $docblock
* @param string $name
* @return array parsed annotations params
*/
private static function parseCustomAnnotations($docblock, $name = 'param')
{
$annotations = [];
$docblock = substr($docblock, 3, -2);
if (preg_match_all('/@' . $name . '(?:\s*(?:\(\s*)?(.*?)(?:\s*\))?)??\s*(?:\n|\*\/)/', $docblock, $matches)) {
foreach ($matches[1] as $k => $v) {
$annotations[] = $v;
}
}
return $annotations;
}
/**
* Parse annotations
*
* @param string $docblock
* @return array parsed annotations params
*/
private static function parseAnnotations($docblock)
{
$annotations = [];
// Strip away the docblock header and footer to ease parsing of one line annotations
$docblock = substr($docblock, 3, -2);
if (preg_match_all('/@(?<name>[A-Za-z_-]+)[\s\t]*\((?<args>(?:(?!\)).)*)\)\r?/s', $docblock, $matches)) {
$numMatches = count($matches[0]);
for ($i = 0; $i < $numMatches; ++$i) {
// annotations has arguments
if (isset($matches['args'][$i])) {
$argsParts = trim($matches['args'][$i]);
$name = $matches['name'][$i];
if ($name == 'ApiReturn') {
$value = $argsParts;
} else {
$argsParts = preg_replace("/\{(\w+)\}/", '#$1#', $argsParts);
$value = self::parseArgs($argsParts);
if (is_string($value)) {
$value = preg_replace("/\#(\w+)\#/", '{$1}', $argsParts);
}
}
} else {
$value = [];
}
$annotations[$name][] = $value;
}
}
return $annotations;
}
/**
* Parse individual annotation arguments
*
* @param string $content arguments string
* @return array annotated arguments
*/
private static function parseArgs($content)
{
// Replace initial stars
$content = preg_replace('/^\s*\*/m', '', $content);
$data = [];
$len = strlen($content);
$i = 0;
$var = '';
$val = '';
$level = 1;
$prevDelimiter = '';
$nextDelimiter = '';
$nextToken = '';
$composing = false;
$type = 'plain';
$delimiter = null;
$quoted = false;
$tokens = ['"', '"', '{', '}', ',', '='];
while ($i <= $len) {
$prev_c = substr($content, $i - 1, 1);
$c = substr($content, $i++, 1);
if ($c === '"' && $prev_c !== "\\") {
$delimiter = $c;
//open delimiter
if (!$composing && empty($prevDelimiter) && empty($nextDelimiter)) {
$prevDelimiter = $nextDelimiter = $delimiter;
$val = '';
$composing = true;
$quoted = true;
} else {
// close delimiter
if ($c !== $nextDelimiter) {
throw new Exception(sprintf(
"Parse Error: enclosing error -> expected: [%s], given: [%s]", $nextDelimiter, $c
));
}
// validating syntax
if ($i < $len) {
if (',' !== substr($content, $i, 1) && '\\' !== $prev_c) {
throw new Exception(sprintf(
"Parse Error: missing comma separator near: ...%s<--", substr($content, ($i - 10), $i)
));
}
}
$prevDelimiter = $nextDelimiter = '';
$composing = false;
$delimiter = null;
}
} elseif (!$composing && in_array($c, $tokens)) {
switch ($c) {
case '=':
$prevDelimiter = $nextDelimiter = '';
$level = 2;
$composing = false;
$type = 'assoc';
$quoted = false;
break;
case ',':
$level = 3;
// If composing flag is true yet,
// it means that the string was not enclosed, so it is parsing error.
if ($composing === true && !empty($prevDelimiter) && !empty($nextDelimiter)) {
throw new Exception(sprintf(
"Parse Error: enclosing error -> expected: [%s], given: [%s]", $nextDelimiter, $c
));
}
$prevDelimiter = $nextDelimiter = '';
break;
case '{':
$subc = '';
$subComposing = true;
while ($i <= $len) {
$c = substr($content, $i++, 1);
if (isset($delimiter) && $c === $delimiter) {
throw new Exception(sprintf(
"Parse Error: Composite variable is not enclosed correctly."
));
}
if ($c === '}') {
$subComposing = false;
break;
}
$subc .= $c;
}
// if the string is composing yet means that the structure of var. never was enclosed with '}'
if ($subComposing) {
throw new Exception(sprintf(
"Parse Error: Composite variable is not enclosed correctly. near: ...%s'", $subc
));
}
$val = self::parseArgs($subc);
break;
}
} else {
if ($level == 1) {
$var .= $c;
} elseif ($level == 2) {
$val .= $c;
}
}
if ($level === 3 || $i === $len) {
if ($type == 'plain' && $i === $len) {
$data = self::castValue($var);
} else {
$data[trim($var)] = self::castValue($val, !$quoted);
}
$level = 1;
$var = $val = '';
$composing = false;
$quoted = false;
}
}
return $data;
}
/**
* Try determinate the original type variable of a string
*
* @param string $val string containing possibles variables that can be cast to bool or int
* @param boolean $trim indicate if the value passed should be trimmed after to try cast
* @return mixed returns the value converted to original type if was possible
*/
private static function castValue($val, $trim = false)
{
if (is_array($val)) {
foreach ($val as $key => $value) {
$val[$key] = self::castValue($value);
}
} elseif (is_string($val)) {
if ($trim) {
$val = trim($val);
}
$val = stripslashes($val);
$tmp = strtolower($val);
if ($tmp === 'false' || $tmp === 'true') {
$val = $tmp === 'true';
} elseif (is_numeric($val)) {
return $val + 0;
}
unset($tmp);
}
return $val;
}
}
@@ -0,0 +1,744 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" />
<meta http-equiv="Cache" content="no-cache">
<meta http-equiv="Pragma" content="no-cache" />
<meta http-equiv="Expires" content="0" />
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title>Api文档</title>
<!-- 依 赖 样 式 -->
<link rel="stylesheet" href="/static/component/laytp/css/laytp.css" />
<!-- 加 载 样 式-->
<link rel="stylesheet" href="/static/admin/css/load.css" />
<!-- 布 局 样 式 -->
<link rel="stylesheet" href="/static/admin/css/apidoc.css" />
</head>
<style>
.api-page-tab-content {
background-color: #fff;
overflow: auto;
min-height: 100%;
}
.api-url {
/*position: relative;*/
color: rgb(221, 17, 68);
background: #f6f6f6;
border: 1px solid #ddd;
}
.layui-form-pane .layui-form-label {
width: 280px;
/*height: 34px;*/
padding: 6px 15px;
}
.layui-form-pane .layui-input-block {
margin-left: 280px;
}
.editormd-preview-container, .editormd-html-preview {
width: 98% !important;
font-size: 16px;
}
.markdown-body li {
/* 使md编辑器中的li取消样式none */
list-style: unset;
}
.api-tab-title {
position: fixed;
left: 230px;
right: 0;
z-index: 999999;
background-color: #fff;
}
.layui-tab-bar{
display:none;
}
</style>
<!-- 结 构 代 码 -->
<body class="layui-layout-body laytp-admin">
<!-- 布 局 框 架 -->
<div class="layui-layout layui-layout-admin">
<div class="layui-header">
<!-- 顶 部 左 侧 功 能 -->
<ul class="layui-nav layui-layout-left">
<li class="collaspe layui-nav-item"><a href="javascript:void(0);" class="layui-icon layui-icon-shrink-right"></a></li>
</ul>
<!-- 顶 部 右 侧 菜 单 -->
<div id="control" class="layui-layout-control"></div>
<ul class="layui-nav layui-layout-right">
<li class="layui-nav-item layui-hide-xs"><a href="javascript:void(0);" class="fullScreen layui-icon layui-icon-screen-full"></a></li>
<!-- 主 题 配 置 -->
<li class="layui-nav-item apiSet"><a href="javascript:void(0);" class="layui-icon layui-icon-set"></a></li>
<li class="layui-nav-item setting"><a href="javascript:void(0);" class="layui-icon layui-icon-more-vertical"></a></li>
</ul>
</div>
<!-- 侧 边 区 域 -->
<div class="layui-side layui-bg-black">
<!-- 菜 单 顶 部 -->
<div class="layui-logo">
<!-- 图 标 -->
<img class="logo" />
<!-- 标 题 -->
<span class="title"></span>
</div>
<!-- 菜 单 内 容 -->
<div>
<ul class="layui-nav arrow layui-nav-tree laytp-nav-tree" style="display: block;">
<li class="layui-nav-item">
<div class="search" style="padding: 5px;">
<input type="text" class="layui-input search-menu" placeholder="搜索文档">
</div>
</li>
</ul>
</div>
<div class="layui-side-scroll">
<div id="sideMenu"></div>
</div>
</div>
<!-- 视 图 页 面 -->
<div class="layui-body">
{php}$key = 0;{/php}
{foreach $apidocList as $k=>$v}
{php}$key++;{/php}
<div class="api-page-tab-content" id="meditor_{$key}" style="display:none;">
<div class="layui-tab layui-tab-brief">
<ul class="layui-tab-title api-tab-title">
<li class="layui-this">
{$v.title}
</li>
</ul>
<div class="layui-tab-content meditorContent api-content" id="meditor_{$v.id}_content">
<textarea style="display:none;">{$v.des}</textarea>
</div>
</div>
</div>
{/foreach}
{foreach $docslist as $k=>$v}
{php}$key++;{/php}
{foreach $v as $ak=>$api}
{php}$key++;{/php}
<div class="api-page-tab-content" id="api_{$key}" style="display:none;">
<div class="layui-tab layui-tab-brief">
<ul class="layui-tab-title api-tab-title">
<li class="layui-this">接口说明</li>
<li>在线测试</li>
</ul>
<div class="layui-tab-content markdown-body api-content">
<div class="layui-tab-item layui-show editormd-html-preview">
<p><strong>简要说明</strong></p>
<ul>
<li>{$api.summary}</li>
</ul>
<p><strong>请求方式</strong></p>
<ul>
<li><code class="api-url">{$api.method}</code></li>
</ul>
<p><strong>请求地址</strong></p>
<ul>
<li><code class="api-url" route="{if $apiDomain && substr($api['route'],0,5) === '/api.'}/{:substr($api['route'],5)}{else /}{$api.route}{/if}">{if $apiDomain && substr($api['route'],0,5) === '/api.'}/{:substr($api['route'],5)}{else /}{$api.route}{/if}</code></li>
</ul>
<p><strong>Headers参数</strong></p>
{if $api.headerslist}
<div style="width: 100%;overflow-x: auto;">
<table class="table table-bordered table-hover">
<thead>
<tr>
<th style="text-align: left;">名称</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
{foreach $api.headerslist as $hk=>$hv}
<tr>
<td style="text-align:left">{$hv.name}</td>
<td style="text-align:left">{$hv.type}</td>
<td style="text-align:left">{if $hv.required}是{else}否{/if}</td>
<td>{$hv.description}</td>
</tr>
{/foreach}
</tbody>
</table>
</div>
{else}
<ul>
<li></li>
</ul>
{/if}
<p><strong>Body参数</strong></p>
{if $api.paramslist}
<div style="width: 100%;overflow-x: auto;">
<table class="table table-bordered table-hover">
<thead>
<tr>
<th style="text-align: left;">名称</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
{foreach $api.paramslist as $pk=>$pv}
<tr>
<td style="text-align:left">{$pv.name}</td>
<td style="text-align:left">{$pv.type}</td>
<td style="text-align:left">{if $pv.required}是{else}否{/if}</td>
<td>{if $pv.sample}{$pv.description} -
例:{$pv.sample}{else}{$pv.description}{/if}
</td>
</tr>
{/foreach}
</tbody>
</table>
</div>
{else}
<ul>
<li></li>
</ul>
{/if}
<p><strong>返回示例</strong></p>
{if $api.return}
<pre><code class="json">{$api.return}</code></pre>
{else}
<ul>
<li></li>
</ul>
{/if}
<p><strong>返回说明</strong></p>
{if $api.returnparamslist}
<div style="width: 100%;overflow-x: auto;">
<table class="table table-bordered table-hover">
<thead>
<tr>
<th style="text-align: left;">名称</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
{foreach $api.returnparamslist as $pk=>$pv}
<tr>
<td style="text-align:left">{$pv.name}</td>
<td style="text-align:left">{$pv.type}</td>
<td style="text-align:left">{$pv.description}</td>
</tr>
{/foreach}
</tbody>
</table>
</div>
{else}
<ul>
<li></li>
</ul>
{/if}
</div>
<div class="layui-tab-item editormd-html-preview">
<div class="layui-card">
<div class="layui-card-header" style="background-color: #F2F2F2;">Body传参</div>
<div class="layui-card-body main-container">
<form class="layui-form layui-form-pane" method="{$api.method}"
route="{if $apiDomain && substr($api['route'],0,5) === '/api.'}/{:substr($api['route'],5)}{else /}{$api.route}{/if}"
lay-filter="test_inline_{$key}" id="test_inline_{$key}">
{foreach $api.paramslist as $pk=>$pv}
<div class="layui-form-item">
<label class="layui-form-label">{$pv.name}</label>
<div class="layui-input-block">
{if($pv.type == 'array')}
<table class="layui-table">
<tbody>
<tr>
<td align="right" style="width:400px">
<input type="text" class="layui-input" name="{$pv.name}[]" autocomplete="off" placeholder="{if $pv.sample}{$pv.description} - 例:{$pv.sample}{else}请输入{$pv.description}{/if}" />
</td>
<td>
<a class="layui-btn layui-btn-primary layui-btn-sm layui-icon layui-icon-delete del-array-param"></a>
</td>
</tr>
<tr>
<td colspan="4">
<a class="layui-btn layui-btn-primary layui-btn-sm layui-icon layui-icon-add-1 add-array-param" data-field="{$pv.name}">追加参数</a>
</td>
</tr>
</tbody>
</table>
{else}
<input type="{if ($pv.type == 'file')}file{else}text{/if}"
name="{$pv.name}" autocomplete="off"
placeholder="{if $pv.sample}{$pv.description} - 例:{$pv.sample}{else}请输入{$pv.description}{/if}"
class="layui-input">
{/if}
</div>
</div>
{/foreach}
<div class="layui-form-item">
<div class="layui-input-block">
<button type="button" class="laytp-btn laytp-btn-primary"
href="javascript:void(0);"
onclick="api.testInline({$key})">提 交
</button>
</div>
</div>
</form>
</div>
</div>
<div class="layui-card" id="response_card_{$key}">
<div class="layui-card-header" style="background-color: #F2F2F2;">响应输出</div>
<div class="layui-card-body">
<pre><code class="json" id="response_{$key}"></code></pre>
<pre class="layui-code" id="response_headers_{$key}"></pre>
</div>
</div>
</div>
</div>
</div>
</div>
{/foreach}
{/foreach}
</div>
<!-- 遮 盖 层 -->
<div class="laytp-cover"></div>
<!-- 加 载 动 画-->
<div class="loader-main">
<div class="loader"></div>
</div>
</div>
<!-- 移 动 端 便 捷 操 作 -->
<div class="laytp-collasped-pe collaspe">
<a href="javascript:void(0);" class="layui-icon layui-icon-shrink-right"></a>
</div>
<!-- 请求配置弹出层内容开始 -->
<script type="text/html" id="set">
<div class="popup-content">
<div class="api-page-tab-content">
<form class="layui-form" lay-filter="setDataForm" id="setDataForm">
<div class="layui-form-item">
<label class="layui-form-label">Api请求域名</label>
<div class="layui-input-block">
<input type="text" name="apiUrl"
placeholder="完整的请求前缀,以http://或者https://开头,不以/结尾" autocomplete="off" class="layui-input"
value="{{d.apiUrl}}">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label" title="开关">签名验证</label>
<div class="layui-input-block">
<!-- 隐藏域设置开关未选中时需要传递的参数值 -->
<input type="hidden" name="createSign" id="createSign-2" value="2"/>
<input type="checkbox" name="createSign" id="createSign-1" lay-skin="switch" lay-text="验证|不验证"
{{# if(d.createSign== 1){ }}checked="checked" {{# } }} value="1"/>
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label" title="Header参数">Header参数</label>
<div class="layui-input-block">
<table class="layui-table">
<thead>
<tr>
<th>参数Key</th>
<th>参数Value</th>
<th>操作</th>
</tr>
</thead>
<tbody>
<tr>
<td align="right">
<input type="text" class="layui-input" value="token" readonly="readonly"/>
</td>
<td>
<input type="text" class="layui-input" name="token" value="{{d.headerJson.token}}"
autocomplete="off"/>
</td>
<td></td>
</tr>
{{# let k; }}
{{# for(k in d.headerJson){ }}
{{# if(k !== "token" && k !== "sign" && k !== "request-time"){ }}
<tr>
<td align="right">
<input type="text" class="layui-input" name="header[key][]" value="{{k}}"
autocomplete="off"/>
</td>
<td>
<input type="text" class="layui-input" name="header[value][]"
value="{{d.headerJson[k]}}" autocomplete="off"/>
</td>
<td>
<a class="layui-btn layui-btn-primary layui-btn-sm layui-icon layui-icon-delete del-header-param"></a>
</td>
</tr>
{{# } }}
{{# } }}
<tr>
<td colspan="4">
<a class="layui-btn layui-btn-primary layui-btn-sm layui-icon layui-icon-add-1 add-header-param">追加参数</a>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</form>
</div>
</div>
</script>
<!-- 请求配置弹出层内容结束 -->
<script type="text/html" id="arrayParam">
<table class="layui-table">
<tbody>
<tr>
<td align="right">
<input type="text" class="layui-input" name="{{d.field}}[]" autocomplete="off"/>
</td>
<td>
<a class="layui-btn layui-btn-primary layui-btn-sm layui-icon layui-icon-delete del-array-param"></a>
</td>
</tr>
<tr>
<td colspan="4">
<a class="layui-btn layui-btn-primary layui-btn-sm layui-icon layui-icon-add-1 add-array-param">追加参数</a>
</td>
</tr>
</tbody>
</table>
</script>
<!-- 依 赖 脚 本 -->
<script type="text/javascript" src="/static/component/jquery_3.3.1.js" charset="utf-8"></script>
<script type="text/javascript" src="/static/component/jquery.serializejson.min.js" charset="utf-8"></script>
<script type="text/javascript" src="/static/component/highlight/highlight.pack.js" charset="utf-8"></script>
<link rel="stylesheet" type="text/css" href="/static/component/highlight/styles/docco.css"/>
<link rel="stylesheet" href="/static/plugin/meditor/css/editormd.css"/>
<script src="/static/plugin/meditor/lib/marked.min.js"></script>
<script src="/static/plugin/meditor/lib/prettify.min.js"></script>
<script src="/static/plugin/meditor/lib/flowchart.min.js"></script>
<script src="/static/plugin/meditor/lib/raphael.min.js"></script>
<script src="/static/plugin/meditor/lib/underscore.min.js"></script>
<script src="/static/plugin/meditor/lib/sequence-diagram.min.js"></script>
<script src="/static/plugin/meditor/lib/jquery.flowchart.min.js"></script>
<script src="/static/plugin/meditor/editormd.min.js"></script>
<script src="https://cdn.bootcdn.net/ajax/libs/blueimp-md5/2.18.0/js/md5.js"></script>
<script>
// 初始化静态文件版本号
localStorage.setItem("version","1.0.2.Release");
document.write("<script src='/static/component/layui/layui.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='/static/component/laytp/layuiConfig.js?v="+localStorage.getItem("version")+"'><\/script>");
</script>
<!-- 框 架 初 始 化 -->
<script>
//定义storage
let storage = (function () {
let storage;
try {
storage = window.localStorage;
return storage;
} catch (exception) {
return false;
}
}());
layui.use(['laytp','apidoc','popup'], function() {
let createSignKey = "{$createSignKey}";
let apiDomain = "{$apiDomain}";
let apiUrl = (apiDomain.length > 0) ? apiDomain : window.location.protocol + "//" + window.location.host;
//请求配置
let nowSetJson = storage.getItem("setJson") ? JSON.parse(storage.getItem("setJson")) : {
apiUrl: apiUrl,
createSign: 2,
headerJson: {token: ""}
};
//渲染所有的meditor编辑器内容
layui.each($(".meditorContent"), function (key, item) {
editormd.markdownToHTML($(item).attr('id'), {
htmlDecode: "style,script,iframe", // you can filter tags decode
emoji: true,
taskList: true,
tex: true, // 默认不解析
flowChart: true, // 默认不解析
sequenceDiagram: true, // 默认不解析
});
});
//当表格列数过长时将自动出现滚动条
var themeColorContext = layui.context.get('theme-color-context');
$.each($('table'), function (i, item) {
if($(this).attr('class') !== 'layui-table'){
$('thead > tr', this).attr('style', 'background-color: '+themeColorContext+';color:white;');
$(this).prop('outerHTML', '<div style="width: 95%;overflow-x: auto;">' + $(this).prop('outerHTML') + '</div>');
}
});
//弹窗展示请求配置
$(document).off("click", ".apiSet").on("click", ".apiSet", function () {
let layerDiv = layui.layer.open({
type: 1,
offset: 'r',
area: ['600px', '100%'],
title: "请求配置",
content: layui.laytpl($("#set").html()).render(nowSetJson),
shade: 0.1,
closeBtn: 0,
shadeClose: false,
anim: -1,
skin: 'layer-anim-right',
move: false,
success: function (layero, index) {
$(document).off("click", '#layui-layer-shade' + index).on("click", '#layui-layer-shade' + index, function () {
var $layero = $('#layui-layer' + index);
$layero.animate({
left: $layero.offset().left + $layero.width()
}, 200, function() {
let formJson = $('#setDataForm').serializeJSON();
let headerJson = {
token: formJson.token
};
let keyJson = {};
if (formJson.hasOwnProperty("header") && formJson.header.hasOwnProperty("key")) {
keyJson = formJson.header.key;
}
let valueJson = {};
if (formJson.hasOwnProperty("header") && formJson.header.hasOwnProperty("value")) {
valueJson = formJson.header.value;
}
$.each(keyJson, function (key, item) {
if(keyJson[key]){
headerJson[keyJson[key]] = valueJson[key];
}
});
let setJson = {
apiUrl: formJson.apiUrl,
createSign: formJson.createSign,
headerJson: headerJson
};
nowSetJson = setJson;
storage.setItem("setJson", JSON.stringify(setJson));
facade.success("保存成功");
layer.close(index);
});
});
},
btn: ['保 存', '取 消'],
yes: function (index, layero) {
let formJson = $('#setDataForm').serializeJSON();
let headerJson = {
token: formJson.token
};
let keyJson = {};
if (formJson.hasOwnProperty("header") && formJson.header.hasOwnProperty("key")) {
keyJson = formJson.header.key;
}
let valueJson = {};
if (formJson.hasOwnProperty("header") && formJson.header.hasOwnProperty("value")) {
valueJson = formJson.header.value;
}
$.each(keyJson, function (key, item) {
if(keyJson[key]){
headerJson[keyJson[key]] = valueJson[key];
}
});
let setJson = {
apiUrl: formJson.apiUrl,
createSign: formJson.createSign,
headerJson: headerJson
};
nowSetJson = setJson;
storage.setItem("setJson", JSON.stringify(setJson));
facade.success("保存成功");
layer.close(index);
}
});
layui.laytpForm.render("#layui-layer" + layerDiv);
});
//追加Header参数
$(document).off("click", ".add-header-param").on("click", ".add-header-param", function () {
let clickObj = $(this);
let template = '<tr>' +
'<td align="right">' +
'<input type="text" class="layui-input" name="header[key][]" autocomplete="off" />' +
'</td>' +
'<td>' +
'<input type="text" class="layui-input" name="header[value][]" autocomplete="off" />' +
'</td>' +
'<td>' +
'<a class="layui-btn layui-btn-primary layui-btn-sm layui-icon layui-icon-delete del-header-param"></a>' +
'</td>' +
'</tr>';
clickObj.parent().parent().before(template);
});
//追加数组参数
$(document).off("click", ".add-array-param").on("click", ".add-array-param", function () {
let clickObj = $(this);
let field = clickObj.data('field');
let template = '<tr>' +
'<td align="right">' +
'<input type="text" class="layui-input" name="' + field + '[]" autocomplete="off" />' +
'</td>' +
'<td>' +
'<a class="layui-btn layui-btn-primary layui-btn-sm layui-icon layui-icon-delete del-array-param"></a>' +
'</td>' +
'</tr>';
clickObj.parent().parent().before(template);
});
//删除header参数
$(document).off("click", ".del-header-param").on("click", ".del-header-param", function () {
let clickObj = $(this);
clickObj.parent().parent().remove();
});
//删除array参数
$(document).off("click", ".del-array-param").on("click", ".del-array-param", function () {
let clickObj = $(this);
clickObj.parent().parent().remove();
});
layui.apidoc.setConfigType("yml");
layui.apidoc.setConfigPath("/static/component/laytp/config/api.config.yml?v=" + localStorage.getItem("version"));
layui.apidoc.render();
// 搜索菜单功能添加在这里,不要添加到js组件里面,因为会在子页面进行调用,这里只会在父页面执行
// 这里被注释的代码,触发搜索菜单要按下回车键
$(".search-menu").focus(
function(){
$(document).on("keydown",
function(event){
if( event.keyCode === 13 ){
window.searchMenuData = [];
var searchKey = $(".search-menu").val();
if(searchKey){
searchMenu(window.menuData, searchKey);
layui.apidoc.setConfigType("yml");
layui.apidoc.setConfigPath("/static/component/laytp/config/api.config.yml?v=" + localStorage.getItem("version"));
var param = layui.apidoc.readConfig();
param.menu.async = false;
param.menu.data = window.searchMenuData;
param.isSearch = true;
layui.apidoc.render(param);
}else{
$("#sideMenu").show();
$("#searchSideMenu").hide();
renderMenu();
}
}
}
);
$(".search-menu").unbind();
}
);
// 递归搜索菜单
window.searchMenu = function(menuData, searchKey){
searchKey = searchKey.toLowerCase();
$.each(menuData, function(i, item) {
var oldTitle = item.title;
item.title = item.title.toLowerCase();
if(item.title.indexOf(searchKey) > -1){
item.title = oldTitle;
window.searchMenuData.push(item);
}else{
item.title = oldTitle;
if(item.children && item.children.length > 0){
searchMenu(item.children, searchKey);
}
}
});
};
// 重新渲染菜单
window.renderMenu = function(){
$(".search-menu").val('');
layui.apidoc.setConfigType("yml");
layui.apidoc.setConfigPath("/static/component/laytp/config/api.config.yml?v=" + localStorage.getItem("version"));
var config = layui.apidoc.readConfig();
layui.apidoc.menuRender(config);
};
window.api = {
testInline: function (id) {
let route = $("#test_inline_" + id).attr('route');
let url = nowSetJson.apiUrl + route;
let method = $("#test_inline_" + id).attr('method');
if (nowSetJson.createSign === "1") {
nowSetJson.headerJson['request-time'] = Date.now();
nowSetJson.headerJson.sign = api.createSign(nowSetJson.headerJson['request-time']);
}
let formData = new FormData();
$('#test_inline_'+id).find('input').each(function (i, input) {
if ($(input).attr('type') == 'file') {
formData.append($(input).attr('name'), $(input)[0].files[0]);
} else {
formData.append($(input).attr('name'), $(input).val())
}
});
$.ajax({
url: url,
headers: nowSetJson.headerJson,
data: $('#test_inline_'+id).prop('method').toLowerCase() == 'get' ? $('#test_inline_'+id).serialize() : formData,
type: method,
dataType: 'json',
contentType: false,
processData: false,
success: function (data, textStatus, xhr) {
if (typeof data === 'object') {
var str = JSON.stringify(data, null, 2);
if(str) {
$('#response_' + id).html(hljs.highlightAuto(str).value);
}
} else {
$('#response_' + id).html(data || '');
}
$('#response_headers_' + id).html('HTTP ' + xhr.status + ' ' + xhr.statusText + '<br/><br/>' + xhr.getAllResponseHeaders());
$('#response_card_' + id).show();
facade.success('请求成功');
},
error: function (xhr) {
try {
var str = JSON.stringify($.parseJSON(xhr.responseText), null, 2);
} catch (e) {
var str = xhr.responseText;
}
$('#response_headers_' + id).html('HTTP ' + xhr.status + ' ' + xhr.statusText + '<br/><br/>' + xhr.getAllResponseHeaders());
if(str){
$('#response_' + id).html(hljs.highlightAuto(str).value);
}
$('#response_card_' + id).show();
facade.error('请求失败');
}
});
return false;
},
createSign: function (requestTime) {
return md5(md5(requestTime) + md5(createSignKey)).toUpperCase();
},
};
});
</script>
</body>
</html>
+18
View File
@@ -0,0 +1,18 @@
<?php
return[[
'name'=>'生成Api文档',
'href'=>'/admin/plugin/apidoc/index.html',
'is_menu'=>1,
'icon'=>'layui-icon layui-icon-read',
'children'=>[
['name'=>'查看和搜索列表', 'rule'=>'/plugin/apidoc/index/index', 'is_menu'=>2, 'icon'=>'layui-icon layui-icon-fire'],
['name'=>'查看单条数据详情', 'rule'=>'/plugin/apidoc/index/info', 'is_menu'=>2, 'icon'=>'layui-icon layui-icon-fire'],
['name'=>'添加', 'rule'=>'/plugin/apidoc/index/add', 'is_menu'=>2, 'icon'=>'layui-icon layui-icon-fire'],
['name'=>'编辑', 'rule'=>'/plugin/apidoc/index/edit', 'is_menu'=>2, 'icon'=>'layui-icon layui-icon-fire'],
['name'=>'生成文档', 'rule'=>'/plugin/apidoc/index/create', 'is_menu'=>2, 'icon'=>'layui-icon layui-icon-fire'],
['name'=>'删除', 'rule'=>'/plugin/apidoc/index/del', 'is_menu'=>2, 'icon'=>'layui-icon layui-icon-fire'],
['name'=>'回收站', 'rule'=>'/plugin/apidoc/index/recycle', 'is_menu'=>2, 'icon'=>'layui-icon layui-icon-fire'],
['name'=>'还原', 'rule'=>'/plugin/apidoc/index/restore', 'is_menu'=>2, 'icon'=>'layui-icon layui-icon-fire'],
['name'=>'真实删除', 'rule'=>'/plugin/apidoc/index/trueDel', 'is_menu'=>2, 'icon'=>'layui-icon layui-icon-fire'],
]
]];
+15
View File
@@ -0,0 +1,15 @@
<?php
/**
* 后台系统配置模型
*/
namespace plugin\apidoc\model;
use laytp\BaseModel;
use think\model\concern\SoftDelete;
class Apidoc extends BaseModel
{
use SoftDelete;
protected $name = 'plugin_apidoc';
}
@@ -0,0 +1,72 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>添加Api文档</title>
</head>
<body>
<form class="layui-form" lay-filter="layui-form">
<div class="mainBox">
<div class="main-container">
<div class="main-container">
<div class="layui-form-item">
<label class="layui-form-label" title="标题">标题</label>
<div class="layui-input-block">
<input autocomplete="off" type="text" name="title" id="title" placeholder="请输入标题" class="layui-input"
lay-verify="required">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label" title="描述">描述</label>
<div class="layui-input-block">
<iframe src="/admin/meditor.html" class="editor" data-type="meditor" data-id="des"
style="width:100%;height:560px;border: 0"></iframe>
</div>
</div>
</div>
</div>
</div>
<div class="bottom">
<div class="button-container">
<button type="button" class="laytp-btn laytp-btn-primary laytp-btn-sm" lay-submit="" lay-filter="add">
<i class="layui-icon layui-icon-ok"></i>
提交
</button>
<button type="reset" class="laytp-btn laytp-btn-sm">
<i class="layui-icon layui-icon-refresh"></i>
重置
</button>
</div>
</div>
</form>
<script>
if(localStorage.getItem("staticDomain")){
document.write("<link rel='stylesheet' href='" + localStorage.getItem("staticDomain") + "/component/laytp/css/laytp.css?v=" + localStorage.getItem("version") + "'>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/component/layui/layui.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/component/laytp/layuiConfig.js?v="+localStorage.getItem("version")+"'><\/script>");
}else{
document.write("<link rel='stylesheet' href='/static/component/laytp/css/laytp.css?v=" + localStorage.getItem("version") + "'>");
document.write("<script src='/static/component/layui/layui.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='/static/component/laytp/layuiConfig.js?v="+localStorage.getItem("version")+"'><\/script>");
}
</script>
<script>
layui.use(['laytp'],function(){
layui.form.on('submit(add)', function(data){
data = facade.setEditorField(data);
facade.ajax({
route:'/plugin/apidoc/index/add',
data : data.field
}).done(function(res){
if(res.code === 0){
parent.layui.layer.close(parent.layui.layer.getFrameIndex(window.name));//关闭当前页
parent.layui.table.reload("laytp-table");
}
});
return false;
});
})
</script>
</body>
</html>
@@ -0,0 +1,100 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>编辑Api文档</title>
</head>
<body>
<script type="text/html" id="form">
<input type="hidden" name="id" value="{{ d.id }}" />
<div class="mainBox">
<div class="main-container">
<div class="main-container">
<div class="layui-form-item">
<label class="layui-form-label" title="标题">标题</label>
<div class="layui-input-block">
<input autocomplete="off" type="text" name="title" id="title" placeholder="请输入标题" class="layui-input"
lay-verify="required" value="{{=d.title}}">
</div>
</div>
<div class="layui-form-item">
<label class="layui-form-label" title="描述">描述</label>
<div class="layui-input-block">
<iframe src="/admin/meditor.html?id=des" class="editor" data-type="meditor" data-id="des"
style="width:100%;height:560px;border: 0"></iframe>
<textarea class="editorContent" data-id="des" style="display:none;">{{=d.des}}</textarea>
</div>
</div>
</div>
</div>
</div>
<div class="bottom">
<div class="button-container">
<button type="button" class="laytp-btn laytp-btn-primary laytp-btn-sm" lay-submit="" lay-filter="edit">
<i class="layui-icon layui-icon-ok"></i>
提交
</button>
<button type="reset" class="laytp-btn laytp-btn-sm">
<i class="layui-icon layui-icon-refresh"></i>
重置
</button>
</div>
</div>
</script>
<form class="layui-form" lay-filter="layui-form"></form>
<script>
if(localStorage.getItem("staticDomain")){
document.write("<link rel='stylesheet' href='" + localStorage.getItem("staticDomain") + "/component/laytp/css/laytp.css?v=" + localStorage.getItem("version") + "'>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/component/layui/layui.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/component/laytp/layuiConfig.js?v="+localStorage.getItem("version")+"'><\/script>");
}else{
document.write("<link rel='stylesheet' href='/static/component/laytp/css/laytp.css?v=" + localStorage.getItem("version") + "'>");
document.write("<script src='/static/component/layui/layui.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='/static/component/laytp/layuiConfig.js?v="+localStorage.getItem("version")+"'><\/script>");
}
</script>
<script>
layui.use(['laytp'],function(){
let form = layui.form;
let $ = layui.jquery;
//获取参数ID
var id = facade.getUrlParam('id');
if(!id){
facade.error('参数ID不能为空');
return false;
}
//获取数据,渲染到对应的节点上
facade.ajax({
route: "/plugin/apidoc/index/info",
data: {id: id},
successAlert: false,
showLoading: true
}).done(function(res){
if(res.code === 0){
layui.laytpl($("#form").html()).render(res.data,function(string){
$("form").html(string);
layui.laytpForm.render();
form.render();
});
}
});
form.on('submit(edit)', function(data){
data = facade.setEditorField(data);
facade.ajax({
route:'/plugin/apidoc/index/edit',
data:data.field
}).done(function(res){
if(res.code === 0){
parent.layui.layer.close(parent.layui.layer.getFrameIndex(window.name));//关闭当前页
parent.layui.table.reload("laytp-table");
}
});
return false;
});
})
</script>
</body>
</html>
@@ -0,0 +1,136 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>用户管理</title>
</head>
<body class="laytp-container">
<div id="search-form" style="display:none;">
<div class="layui-layer-title">搜索</div>
<form class="layui-form search-form-body" lay-filter="layui-form">
<div class="layui-form-item layui-inline">
<label class="layui-form-label" title="ID">ID</label>
<div class="layui-input-inline">
<input autocomplete="off" type="text" id="id" name="search_param[id][value]" id="id"
placeholder="请输入ID" class="layui-input">
<input type="hidden" name="search_param[id][condition]" value="=">
</div>
</div>
<div class="layui-form-item layui-inline">
<label class="layui-form-label" title="标题">标题</label>
<div class="layui-input-inline">
<input autocomplete="off" type="text" id="title" name="search_param[title][value]"
placeholder="请输入标题" class="layui-input">
<input type="hidden" name="search_param[title][condition]" value="LIKE">
</div>
</div>
<div class="layui-form-item layui-inline">
<label class="layui-form-label" title="描述">描述</label>
<div class="layui-input-inline">
<input autocomplete="off" type="text" id="des" name="search_param[des][value]" placeholder="请输入描述"
class="layui-input">
<input type="hidden" name="search_param[des][condition]" value="LIKE">
</div>
</div>
<div class="layui-form-item layui-inline">
<label class="layui-form-label" title="创建时间">创建时间</label>
<div class="layui-input-inline">
<input type="text" class="layui-input laydate"
id="create_time" name="search_param[create_time][value]"
data-type="datetime" data-isRange="true" placeholder="请选择创建时间">
<input type="hidden" name="search_param[create_time][condition]" value="BETWEEN">
</div>
</div>
<div class="bottom">
<div class="button-container">
<button class="laytp-btn laytp-btn-primary laytp-btn-sm" lay-submit="" lay-filter="laytp-recycle-search-form">
<i class="layui-icon layui-icon-ok"></i>
提交
</button>
<button type="button" class="laytp-btn laytp-btn-sm laytp-recycle-search-form-reset">
<i class="layui-icon layui-icon-refresh"></i>
重置
</button>
</div>
</div>
</form>
</div>
<div class="layui-card">
<div class="layui-card-body">
<table id="laytp-table" lay-filter="laytp-table"></table>
</div>
</div>
<script type="text/html" id="default-toolbar">
<div class="dropdown-menu">
<button class="laytp-btn laytp-btn-primary laytp-btn-md">
<i class="layui-icon layui-icon-triangle-d"></i>
批量操作
</button>
<ul class="dropdown-menu-nav layui-anim-upbit dropdown-bottom-left layui-anim">
<div class="dropdown-anchor"></div>
{{# if(facade.hasAuth("/plugin/apidoc/index/edit")){ }}
<li><a lay-event="edit"><i class="layui-icon layui-icon-edit"></i></a></li>
{{# } }}
{{# if(facade.hasAuth("/plugin/apidoc/index/del")){ }}
<li><a lay-event="del"><i class="layui-icon layui-icon-delete"></i></a></li>
{{# } }}
</ul>
</div>
{{# if(facade.hasAuth("/plugin/apidoc/index/add")){ }}
<button class="laytp-btn laytp-btn-danger laytp-btn-md" lay-event="add">
<i class="layui-icon layui-icon-add-1"></i>
新增
</button>
{{# } }}
<button class="laytp-btn laytp-btn-warming laytp-btn-md" lay-event="search">
<i class="layui-icon layui-icon-search"></i>
搜索
</button>
{{# if(facade.hasAuth("/plugin/apidoc/index/recycle")){ }}
<button class="laytp-btn laytp-btn-success laytp-btn-md" lay-event="recycle">
<i class="layui-icon layui-icon-delete"></i>
回收站
</button>
{{# } }}
{{# if(facade.hasAuth("/plugin/apidoc/index/create")){ }}
<button class="laytp-btn laytp-btn-default laytp-btn-md"lay-event="create">
<i class="layui-icon layui-icon-tabs"></i>
生成Api文档
</button>
{{# } }}
{{# if(facade.hasAuth("/plugin/apidoc/index/create")){ }}
<button class="laytp-btn laytp-btn-primary laytp-btn-md fa fa-binoculars"
lay-event="open">&nbsp;查看Api文档
</button>
{{# } }}
</script>
<script type="text/html" id="default-bar">
{{# if(facade.hasAuth("/plugin/apidoc/index/edit")){ }}
<button class="laytp-btn laytp-btn-primary laytp-btn-xs" lay-event="edit"><i class="layui-icon layui-icon-edit"></i></button>
{{# } }}
{{# if(facade.hasAuth("/plugin/apidoc/index/del")){ }}
<button class="laytp-btn laytp-btn-danger laytp-btn-xs" lay-event="del"><i class="layui-icon layui-icon-delete"></i></button>
{{# } }}
</script>
<script>
if(localStorage.getItem("staticDomain")){
document.write("<link rel='stylesheet' href='" + localStorage.getItem("staticDomain") + "/component/laytp/css/laytp.css?v=" + localStorage.getItem("version") + "'>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/component/layui/layui.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/component/laytp/layuiConfig.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/plugin/apidoc/js/index.js?v="+localStorage.getItem("version")+"'><\/script>");
}else{
document.write("<link rel='stylesheet' href='/static/component/laytp/css/laytp.css?v=" + localStorage.getItem("version") + "'>");
document.write("<script src='/static/component/layui/layui.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='/static/component/laytp/layuiConfig.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='/static/plugin/apidoc/js/index.js?v="+localStorage.getItem("version")+"'><\/script>");
}
</script>
</body>
</html>
@@ -0,0 +1,102 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Api文档回收站</title>
</head>
<body class="laytp-container-recycle">
<div id="recycle-search-form" style="display:none;">
<div class="layui-layer-title">搜索</div>
<form class="layui-form search-form-body" lay-filter="layui-form">
<div class="layui-form-item layui-inline">
<label class="layui-form-label" title="ID">ID</label>
<div class="layui-input-inline">
<input autocomplete="off" type="text" id="id" name="search_param[id][value]" id="id"
placeholder="请输入ID" class="layui-input">
<input type="hidden" name="search_param[id][condition]" value="=">
</div>
</div>
<div class="layui-form-item layui-inline">
<label class="layui-form-label" title="标题">标题</label>
<div class="layui-input-inline">
<input autocomplete="off" type="text" id="title" name="search_param[title][value]"
placeholder="请输入标题" class="layui-input">
<input type="hidden" name="search_param[title][condition]" value="LIKE">
</div>
</div>
<div class="layui-form-item layui-inline">
<label class="layui-form-label" title="描述">描述</label>
<div class="layui-input-inline">
<input autocomplete="off" type="text" id="des" name="search_param[des][value]" placeholder="请输入描述"
class="layui-input">
<input type="hidden" name="search_param[des][condition]" value="LIKE">
</div>
</div>
<div class="layui-form-item layui-inline">
<label class="layui-form-label" title="创建时间">创建时间</label>
<div class="layui-input-inline">
<input type="text" class="layui-input laydate"
id="create_time" name="search_param[create_time][value]"
data-type="datetime" data-isRange="true" placeholder="请选择创建时间">
<input type="hidden" name="search_param[create_time][condition]" value="BETWEEN">
</div>
</div>
<div class="bottom">
<div class="button-container">
<button class="laytp-btn laytp-btn-primary laytp-btn-sm" lay-submit="" lay-filter="laytp-recycle-search-form">
<i class="layui-icon layui-icon-ok"></i>
提交
</button>
<button type="button" class="laytp-btn laytp-btn-sm laytp-recycle-search-form-reset">
<i class="layui-icon layui-icon-refresh"></i>
重置
</button>
</div>
</div>
</form>
</div>
<div class="layui-card">
<div class="layui-card-body">
<table id="laytp-recycle-table" lay-filter="laytp-recycle-table"></table>
</div>
</div>
<script type="text/html" id="recycle-default-toolbar">
<button class="laytp-btn laytp-btn-primary laytp-btn-md" lay-event="restore">
<i class="laytp-icon laytp-icon-back"></i>
还原
</button>
<button class="laytp-btn laytp-btn-danger laytp-btn-md" lay-event="true-del">
<i class="layui-icon layui-icon-delete"></i>
删除
</button>
<button class="laytp-btn laytp-btn-warming laytp-btn-md" lay-event="recycle-search">
<i class="layui-icon layui-icon-search"></i>
搜索
</button>
</script>
<script type="text/html" id="recycle-default-bar">
<button class="laytp-btn laytp-btn-primary laytp-btn-xs" lay-event="restore"><i class="laytp-icon laytp-icon-back"></i></button>
<button class="laytp-btn laytp-btn-danger laytp-btn-xs" lay-event="true-del"><i class="layui-icon layui-icon-delete"></i></button>
</script>
<script>
if(localStorage.getItem("staticDomain")){
document.write("<link rel='stylesheet' href='" + localStorage.getItem("staticDomain") + "/component/laytp/css/laytp.css?v=" + localStorage.getItem("version") + "'>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/component/layui/layui.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/component/laytp/layuiConfig.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='" + localStorage.getItem("staticDomain") + "/plugin/apidoc/js/recycle.js?v="+localStorage.getItem("version")+"'><\/script>");
}else{
document.write("<link rel='stylesheet' href='/static/component/laytp/css/laytp.css?v=" + localStorage.getItem("version") + "'>");
document.write("<script src='/static/component/layui/layui.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='/static/component/laytp/layuiConfig.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script src='/static/plugin/apidoc/js/recycle.js?v="+localStorage.getItem("version")+"'><\/script>");
}
</script>
</body>
</html>
@@ -0,0 +1,79 @@
---
## 网站配置
logo:
## 网站名称
title: "Api文档"
## 网站图标
image: "/static/admin/images/logo.png"
## 菜单配置
menu:
## 菜单数据来源
data: "/plugin/apidoc/index/getMenu"
## 菜单接口的请求方式 GET / POST
method: "GET"
## 是否同时只打开一个菜单目录
accordion: true
## 是否开启多系统菜单模式
control: true
## 当control为true时,顶部最多显示多少菜单,其他顶部菜单需要点击最后的顶部下拉菜单进行展示
maxTopMenuNum: 8
## 默认选中的菜单项
select: "1"
## 是否开启异步菜单,false 时 data 属性设置为菜单数据,true 时为 json 文件或后端接口
async: true
## 视图内容配置
tab:
## 是否开启多选项卡
muiltTab: true
## 保持视图状态
keepState: false
## 开启选项卡记忆
session: true
## 最大可打开的选项卡数量
tabMax: "30"
## 首页
index:
id: "2" ## 标识 ID , 建议与菜单项中的 ID 一致
href: "/admin/console.html" ## 页面地址
title: "控制面板" ## 标题
## 主题配置
theme:
## 默认主题色,对应 colors 配置中的 ID 标识
defaultColor: "2"
## 默认的菜单主题 dark-theme 黑 / light-theme 白
defaultMenu: "dark-theme"
## 是否允许用户切换主题,false 时关闭自定义主题面板
allowCustom: true
## 主题色配置列表
colors:
- id: "1"
color: "#2d8cf0"
- id: "2"
color: "#36b368"
- id: "3"
color: "#f6ad55"
- id: "4"
color: "#f56c6c"
- id: "5"
color: "#3963bc"
## 主题面板的链接列表
links:
- icon: "layui-icon layui-icon-website"
title: "官方网站"
href: "http://www.laytp.com"
- icon: "layui-icon layui-icon-read"
title: "开发文档"
href: "https://www.laytp.com/doc.html"
- icon: "layui-icon layui-icon-fonts-code"
title: "开源地址"
href: "https://gitee.com/junstar/laytp"
## 其他配置
other:
## 主页动画时长
keepLoad: "500"
## 布局顶部主题
autoHead: false
## 头部配置
header:
## 站内消息,数据来源,通过 false 设置关闭
message: false
@@ -0,0 +1,522 @@
layui.define([
'message',
'table',
'jquery',
'element',
'yaml',
'form',
'laytpTab',
'apimenu',
'frame',
'theme',
'convert'
],
function(exports) {
"use strict";
var $ = layui.jquery,
form = layui.form,
element = layui.element,
yaml = layui.yaml,
laytpTab = layui.laytpTab,
convert = layui.convert,
laytpApiMenu = layui.apimenu,
laytpFrame = layui.frame,
laytpTheme = layui.theme,
message = layui.message;
var bodyFrame;
var sideMenu;
var bodyTab;
var config;
var logout = function() {};
var msgInstance;
var body = layui.$('body');
var laytpApidoc = new function() {
// 默认配置
var configType = 'yml';
var configPath = 'api.config.yml';
this.setConfigPath = function(path) {
configPath = path;
};
this.setConfigType = function(type) {
configType = type;
};
this.setAvatar = function(url, username) {
var image = new Image();
image.src = url || "/static/admin/images/avatar.jpg";
image.onload = function() {
layui.$(".layui-nav-img").attr("src", convert.imageToBase64(image));
};
layui.$(".layui-nav-img").parent().append(username);
};
this.render = function(initConfig) {
if (initConfig !== undefined) {
applyConfig(initConfig);
} else {
applyConfig(laytpApidoc.readConfig());
}
};
this.readConfig = function() {
if (configType === "yml") {
return yaml.load(configPath);
} else {
var data;
$.ajax({
url: configPath,
type: 'get',
dataType: 'json',
async: false,
success: function(result) {
data = result;
}
});
return data;
}
};
this.messageRender = function(option) {
var option = {
elem: '.message',
url: option.header.message,
height: '250px'
};
msgInstance = message.render(option);
};
this.logoRender = function(param) {
layui.$(".layui-logo .logo").attr("src", param.logo.image);
layui.$(".layui-logo .title").html(param.logo.title);
};
this.menuRender = function(param) {
sideMenu = laytpApiMenu.render({
elem: 'sideMenu',
async: param.menu.async !== undefined ? param.menu.async : true,
theme: "dark-theme",
// height: '100%',
method: param.menu.method,
control: param.menu.control ? 'control' : false, // control
defaultMenu: 0,
accordion: param.menu.accordion,
url: param.menu.data,
data: param.menu.data, //async为false时,传入菜单数组
parseData: function(res){
if(param.isSearch){
var result = {
"id" : -1,
"is_menu" : 1,
"is_show" : 1,
"title" : "搜索结果",
"type" : 0,
"children" : res,
"href" : "",
"icon" : ""
};
var resArr = [];
resArr.push(result);
return resArr;
}else{
window.menuData = laytpApidoc.parseData(res.data);
return window.menuData;
}
},
change: function() {
compatible();
},
done: function() {
let firstMenuObj = layui.$("#sideMenu a[menu-id='" + param.menu.select + "']").parent();
let menuType = $(firstMenuObj.html()).attr("doc-type");
let id = $(firstMenuObj.html()).attr("menu-id");
$('.api-page-tab-content').hide();
$('#' + menuType + '_' + id).show();
sideMenu.selectItem(param.menu.select);
}
});
};
this.parseData = function(data){
$.each(data, function(i, item) {
var tempItem = item;
// tempItem.id = item.id;
// tempItem.href = item.href;
// tempItem.icon = item.icon;
tempItem.type = 0;
// tempItem.title = item.name;
if(typeof item.children != null && typeof item.children !== "undefined" && item.children.length > 0){
tempItem.children = laytpApidoc.parseData(item.children);
}else{
tempItem.type = 1;
}
data[i] = tempItem;
});
return data;
};
this.bodyRender = function(param) {
if (param.tab.muiltTab) {
sideMenu.click(function(dom, data) {
let menuType = data.docType;
let id = data.menuId;
$('.api-page-tab-content').hide();
$('#' + menuType + '_' + id).show();
compatible();
});
} else {
sideMenu.click(function(dom, data) {
let menuType = data.docType;
let id = data.menuId;
$('.api-page-tab-content').hide();
$('#' + menuType + '_' + id).show();
compatible();
});
}
};
this.keepLoad = function(param) {
compatible();
setTimeout(function() {
layui.$(".loader-main").fadeOut(200);
}, param.other.keepLoad)
};
this.themeRender = function(option) {
if (option.theme.allowCustom === false) {
layui.$(".setting").remove();
}
var colorId = localStorage.getItem("theme-color");
var currentColor = getColorById(colorId);
localStorage.setItem("theme-color", currentColor.id);
localStorage.setItem("theme-color-context", currentColor.color);
laytpTheme.changeTheme(window, option.other.autoHead);
var menu = localStorage.getItem("theme-menu");
if (menu == null) {
menu = option.theme.defaultMenu;
} else {
if (option.theme.allowCustom === false) {
menu = option.theme.defaultMenu;
}
}
localStorage.setItem("theme-menu", menu);
this.menuSkin(menu);
}
this.menuSkin = function(theme) {
var laytpApidoc = layui.$(".laytp-admin");
laytpApidoc.removeClass("light-theme");
laytpApidoc.removeClass("dark-theme");
laytpApidoc.addClass(theme);
}
this.logout = function(callback) {
logout = callback;
}
this.message = function(callback) {
if (callback != null) {
msgInstance.click(callback);
} else {
msgInstance.click(messageTip);
}
}
this.jump = function(id, title, url) {
if (config.tab.muiltTab) {
bodyTab.addTabOnly({
id: id,
title: title,
url: url,
icon: null,
close: true
}, 300);
} else {
sideMenu.selectItem(id);
bodyFrame.changePage(url, title, true);
}
}
};
var messageTip = function(id, title, context, form) {
layer.open({
type: 1,
title: '消息', //标题
area: ['390px', '330px'], //宽高
shade: 0.4, //遮罩透明度
content: "<div style='background-color:whitesmoke;'><div class='layui-card'><div class='layui-card-body'>来源 : &nbsp; " +
form + "</div><div class='layui-card-header' >标题 : &nbsp; " + title +
"</div><div class='layui-card-body' >内容 : &nbsp; " + context + "</div></div></div>", //支持获取DOM元素
btn: ['确认'], //按钮组
scrollbar: false, //屏蔽浏览器滚动条
yes: function(index) { //layer.msg('yes'); //点击确定回调
layer.close(index);
showToast();
}
});
}
function collaspe() {
sideMenu.collaspe();
var admin = layui.$(".laytp-admin");
var left = layui.$(".layui-icon-spread-left")
var right = layui.$(".layui-icon-shrink-right")
if (admin.is(".laytp-mini")) {
$(".search").show();
left.addClass("layui-icon-shrink-right")
left.removeClass("layui-icon-spread-left")
admin.removeClass("laytp-mini");
} else {
$(".search").hide();
right.addClass("layui-icon-spread-left")
right.removeClass("layui-icon-shrink-right")
admin.addClass("laytp-mini");
}
}
body.on("click", ".logout", function() {
// 回调
var result = logout();
if (result) {
// 清空缓存
bodyTab.clear();
}
})
body.on("click", ".collaspe,.laytp-cover", function() {
collaspe();
});
body.on("click", ".fullScreen", function() {
if (layui.$(this).hasClass("layui-icon-screen-restore")) {
screenFun(2).then(function() {
layui.$(".fullScreen").eq(0).removeClass("layui-icon-screen-restore");
});
} else {
screenFun(1).then(function() {
layui.$(".fullScreen").eq(0).addClass("layui-icon-screen-restore");
});
}
});
body.on("click", '[user-menu-id]', function() {
if (config.tab.muiltTab) {
bodyTab.addTabOnly({
id: layui.$(this).attr("user-menu-id"),
title: layui.$(this).attr("user-menu-title"),
url: layui.$(this).attr("user-menu-url"),
icon: "",
close: true
}, 300);
} else {
bodyFrame.changePage(layui.$(this).attr("user-menu-url"), "", true);
}
});
body.on("click", ".setting", function() {
var bgColorHtml =
'<li class="layui-this" data-select-bgcolor="dark-theme" >' +
'<a href="javascript:;" data-skin="skin-blue" style="" class="clearfix full-opacity-hover">' +
'<div><span style="display:block; width: 20%; float: left; height: 12px; background: #28333E;"></span><span style="display:block; width: 80%; float: left; height: 12px; background: white;"></span></div>' +
'<div><span style="display:block; width: 20%; float: left; height: 40px; background: #28333E;"></span><span style="display:block; width: 80%; float: left; height: 40px; background: #f4f5f7;"></span></div>' +
'</a>' +
'</li>';
bgColorHtml +=
'<li data-select-bgcolor="light-theme" >' +
'<a href="javascript:;" data-skin="skin-blue" style="" class="clearfix full-opacity-hover">' +
'<div><span style="display:block; width: 20%; float: left; height: 12px; background: white;"></span><span style="display:block; width: 80%; float: left; height: 12px; background: white;"></span></div>' +
'<div><span style="display:block; width: 20%; float: left; height: 40px; background: white;"></span><span style="display:block; width: 80%; float: left; height: 40px; background: #f4f5f7;"></span></div>' +
'</a>' +
'</li>';
var html =
'<div class="laytpone-color">\n' +
'<div class="color-title">整体风格</div>\n' +
'<div class="color-content">\n' +
'<ul>\n' + bgColorHtml + '</ul>\n' +
'</div>\n' +
'</div>';
layer.open({
type: 1,
offset: 'r',
area: ['320px', '100%'],
title: false,
shade: 0.1,
closeBtn: 0,
shadeClose: false,
anim: -1,
skin: 'layer-anim-right',
move: false,
content: html + buildColorHtml() + buildLinkHtml() + bottomTool(),
success: function(layero, index) {
var color = localStorage.getItem("theme-color");
var menu = localStorage.getItem("theme-menu");
if (color !== "null") {
layui.$(".select-color-item").removeClass("layui-icon").removeClass("layui-icon-ok");
layui.$("*[color-id='" + color + "']").addClass("layui-icon").addClass("layui-icon-ok");
}
if (menu !== "null") {
layui.$("*[data-select-bgcolor]").removeClass("layui-this");
layui.$("[data-select-bgcolor='" + menu + "']").addClass("layui-this");
}
layui.$('#layui-layer-shade' + index).click(function() {
var $layero = layui.$('#layui-layer' + index);
$layero.animate({
left: $layero.offset().left + $layero.width()
}, 200, function() {
layer.close(index);
});
})
layui.$('#closeTheme').click(function() {
var $layero = layui.$('#layui-layer' + index);
$layero.animate({
left: $layero.offset().left + $layero.width()
}, 200, function() {
layer.close(index);
});
})
}
});
});
function bottomTool() {
return "<button id='closeTheme' style='position: absolute;bottom: 20px;left: 20px;' class='laytp-btn'>关闭</button>"
}
body.on('click', '[data-select-bgcolor]', function() {
var theme = layui.$(this).attr('data-select-bgcolor');
layui.$('[data-select-bgcolor]').removeClass("layui-this");
layui.$(this).addClass("layui-this");
localStorage.setItem("theme-menu", theme);
laytpApidoc.menuSkin(theme);
});
body.on('click', '.select-color-item', function() {
layui.$(".select-color-item").removeClass("layui-icon").removeClass("layui-icon-ok");
layui.$(this).addClass("layui-icon").addClass("layui-icon-ok");
var colorId = layui.$(".select-color-item.layui-icon-ok").attr("color-id");
var currentColor = getColorById(colorId);
localStorage.setItem("theme-color", currentColor.id);
localStorage.setItem("theme-color-context", currentColor.color);
laytpTheme.changeTheme(window, config.other.autoHead);
});
function applyConfig(param) {
config = param;
laytpApidoc.logoRender(param);
laytpApidoc.menuRender(param);
laytpApidoc.bodyRender(param);
laytpApidoc.themeRender(param);
laytpApidoc.keepLoad(param);
if (param.header.message !== false) {
laytpApidoc.messageRender(param);
}
}
function getColorById(id) {
var color;
var flag = false;
$.each(config.colors, function(i, value) {
if (value.id === id) {
color = value;
flag = true;
}
})
if (flag === false || config.theme.allowCustom === false) {
$.each(config.colors, function(i, value) {
if (value.id === config.theme.defaultColor) {
color = value;
}
})
}
return color;
}
function buildLinkHtml() {
var links = "";
$.each(config.links, function(i, value) {
links += '<a class="more-menu-item" href="' + value.href + '">' +
'<i class="' + value.icon + '" style="font-size: 19px;"></i> ' + value.title +
'</a>'
})
return '<div class="more-menu-list">' + links + '</div>';
}
function buildColorHtml() {
return "";
var colors = "";
$.each(config.colors, function(i, value) {
colors += "<span class='select-color-item' color-id='" + value.id + "' style='background-color:" + value.color +
";'></span>";
})
return "<div class='select-color'><div class='select-color-title'>主题配色</div><div class='select-color-content'>" +
colors + "</div></div>"
}
function compatible() {
if (layui.$(window).width() <= 768) {
collaspe()
}
}
function screenFun(num) {
num = num || 1;
num = num * 1;
var docElm = document.documentElement;
switch (num) {
case 1:
if (docElm.requestFullscreen) {
docElm.requestFullscreen();
} else if (docElm.mozRequestFullScreen) {
docElm.mozRequestFullScreen();
} else if (docElm.webkitRequestFullScreen) {
docElm.webkitRequestFullScreen();
} else if (docElm.msRequestFullscreen) {
docElm.msRequestFullscreen();
}
break;
case 2:
if (document.exitFullscreen) {
document.exitFullscreen();
} else if (document.mozCancelFullScreen) {
document.mozCancelFullScreen();
} else if (document.webkitCancelFullScreen) {
document.webkitCancelFullScreen();
} else if (document.msExitFullscreen) {
document.msExitFullscreen();
}
break;
}
return new Promise(function(res, rej) {
res("返回值");
});
}
function isFullscreen() {
return document.fullscreenElement ||
document.msFullscreenElement ||
document.mozFullScreenElement ||
document.webkitFullscreenElement || false;
}
window.onresize = function() {
if (!isFullscreen()) {
layui.$(".fullScreen").eq(0).removeClass("layui-icon-screen-restore");
}
}
exports('apidoc', laytpApidoc);
})
@@ -0,0 +1,491 @@
layui.define(['table', 'jquery', 'element'], function(exports) {
"use strict";
var MOD_NAME = 'apimenu',
$ = layui.jquery,
element = layui.element;
var laytpApiMenu = function(opt) {
this.option = opt;
};
// 供外部调用的,渲染菜单方法
laytpApiMenu.prototype.render = function(opt) {
var option = {
elem: opt.elem,
async: opt.async,
parseData: opt.parseData,
url: opt.url,
method: opt.method ? opt.method : "GET",
defaultOpen: opt.defaultOpen,
defaultSelect: opt.defaultSelect,
control: opt.control,
defaultMenu: opt.defaultMenu,
accordion: opt.accordion,
height: opt.height,
theme: opt.theme,
data: opt.data ? opt.data : [],
change: opt.change ? opt.change : function() {},
done: opt.done ? opt.done : function() {}
};
if (option.async) {
if (option.method === "GET") {
getData(option.url).then(function(data) {
option.data = data;
renderMenu(option);
});
} else {
postData(option.url).then(function(data) {
option.data = data;
renderMenu(option);
});
}
} else {
//renderMenu中需要调用done事件,done事件中需要menu对象,但是此时还未返回menu对象,做个延时提前返回对象
window.setTimeout(function() { renderMenu(option);}, 500);
}
// 处理高度
layui.$("#"+opt.elem).height(option.height);
return new laytpApiMenu(opt);
};
// 任意左侧菜单绑定点击事件
laytpApiMenu.prototype.click = function(clickEvent) {
var _this = this;
layui.$(document).off("click", "#" + _this.option.elem + " .site-demo-active").on("click", "#" + _this.option.elem + " .site-demo-active", function() {
// layui.$("body").on("click", "#" + _this.option.elem + " .site-demo-active", function() {
var dom = layui.$(this);
var data = {
menuId: dom.attr("menu-id"),
docType: dom.attr("doc-type"),
menuTitle: dom.attr("menu-title"),
};
var doms = hash(dom);
if (doms != null) {
if (doms.text() != '') {
data['menuPath'] = doms.find("span").text() + " / " + data['menuPath'];
}
}
if (doms != null) {
var domss = hash(doms);
if(domss!=null){
if (domss.text() != '') {
data['menuPath'] = domss.find("span").text() + " / " + data['menuPath'];
}}
}
if (domss != null) {
var domsss = hash(domss);
if(domsss!=null){
if (domsss.text() != '') {
data['menuPath'] = domsss.find("span").text() + " / " + data['menuPath'];
}}
}
if (layui.$("#" + _this.option.elem).is(".laytp-nav-mini")) {
if (_this.option.accordion) {
activeMenus = layui.$(this).parent().parent().parent().children("a");
} else {
activeMenus.push(layui.$(this).parent().parent().parent().children("a"));
}
}
clickEvent(dom, data);
})
};
function hash(dom) {
var d = dom.parent().parent().prev();
if (d.prop("tagName") === "UL") {
return null;
}
return d;
}
// 样式选择
laytpApiMenu.prototype.skin = function(skin) {
var menu = layui.$(".laytp-nav-tree[lay-filter='" + this.option.elem + "']").parent();
menu.removeClass("dark-theme");
menu.removeClass("light-theme");
menu.addClass(skin);
};
// 选择没有子级的菜单节点
laytpApiMenu.prototype.selectItem = function(laytpId) {
if (this.option.control != false) {
layui.$("#" + this.option.elem + " a[menu-id='" + laytpId + "']").parents(".layui-side-scroll ").find("ul").css({
display: "none"
});
layui.$("#" + this.option.elem + " a[menu-id='" + laytpId + "']").parents(".layui-side-scroll ").find(".layui-this").removeClass(
"layui-this");
layui.$("#" + this.option.elem + " a[menu-id='" + laytpId + "']").parents("ul").css({
display: "block"
});
var controlId = layui.$("#" + this.option.elem + " a[menu-id='" + laytpId + "']").parents("ul").attr("menu-id");
if (controlId != undefined) {
layui.$("#" + this.option.control).find(".layui-this").removeClass("layui-this");
layui.$("#" + this.option.control).find("[menu-id='" + controlId + "']").addClass("layui-this");
}
}
if (this.option.accordion === true) {
layui.$("#" + this.option.elem + " a[menu-id='" + laytpId + "']").parents(".laytp-nav-tree").find(".layui-nav-itemed").removeClass(
"layui-nav-itemed");
}
layui.$("#" + this.option.elem + " a[menu-id='" + laytpId + "']").parents(".laytp-nav-tree").find(".layui-this").removeClass(
"layui-this");
if (!layui.$("#" + this.option.elem).is(".laytp-nav-mini")) {
layui.$("#" + this.option.elem + " a[menu-id='" + laytpId + "']").parents(".layui-nav-item").addClass("layui-nav-itemed");
layui.$("#" + this.option.elem + " a[menu-id='" + laytpId + "']").parents("dd").addClass("layui-nav-itemed");
}
layui.$("#" + this.option.elem + " a[menu-id='" + laytpId + "']").parent().addClass("layui-this");
}
var activeMenus;
// 手机模式下,右下角按钮点击展开收缩左侧菜单事件
laytpApiMenu.prototype.collaspe = function(time) {
var elem = this.option.elem;
var config = this.option;
if (layui.$("#" + this.option.elem).is(".laytp-nav-mini")) {
$.each(activeMenus, function(i, item) {
layui.$("#" + elem + " a[menu-id='" + layui.$(this).attr("menu-id") + "']").parent().addClass("layui-nav-itemed");
});
layui.$("#" + this.option.elem).removeClass("laytp-nav-mini");
layui.$("#" + this.option.elem).animate({
width: "220px"
}, 150);
isHoverMenu(false, config);
} else {
activeMenus = layui.$("#" + this.option.elem).find(".layui-nav-itemed>a");
layui.$("#" + this.option.elem).find(".layui-nav-itemed").removeClass("layui-nav-itemed");
layui.$("#" + this.option.elem).addClass("laytp-nav-mini");
layui.$("#" + this.option.elem).animate({
width: "60px"
}, 400);
isHoverMenu(true, config);
}
};
function getData(url) {
var defer = $.Deferred();
var contact = (url.indexOf('?') > -1) ? "&" : "?";
$.get(url + contact + "fresh=" + Math.random(), function(result) {
defer.resolve(result)
});
return defer.promise();
}
function postData(url) {
var defer = $.Deferred();
$.post(url + "?fresh=" + Math.random(), function(result) {
defer.resolve(result)
});
return defer.promise();
}
// 内部使用,渲染菜单函数
function renderMenu(option) {
if (option.parseData != false) {
option.data = option.parseData(option.data);
}
if (option.data.length > 0) {
if (option.control != false) {
createMenuAndControl(option);
} else {
createMenu(option);
}
}
element.init();
downShow(option);
option.done();
}
// 创建菜单
function createMenu(option) {
var menuHtml = '<div style="height:100%!important;" class="laytp-side-scroll layui-side-scroll ' + option.theme + '"><ul lay-filter="' + option.elem +
'" class="layui-nav arrow laytp-menu layui-nav-tree laytp-nav-tree">';
$.each(option.data, function(i, item) {
var content = '<li class="layui-nav-item">';
if (i === option.defaultOpen) {
content = '<li class="layui-nav-item layui-nav-itemed">';
}
var href = "javascript:void(0);";
var className = "site-demo-active";
if (item.openType === "_blank" && item.type === 1) {
className = "";
}
if (item.type === 0) {
// 创 建 目 录 结 构
content += '<a href="javascript:;" menu-type="' + item.type + '" doc-type="' + item.docType + '" menu-id="' + item.id + '" href="' + href + '">' +
'<span>' + item.title + '</span></a>';
} else if (item.type === 1) {
content += '<a class="' + className + '" menu-type="' + item.type + '" doc-type="' + item.docType + '" menu-id="' +
item.id +
'" menu-title="' + item.title + '" href="' + href + '"><span>' + item.title + '</span></a>';
}
// 调 用 递 归 方 法 加 载 无 限 层 级 的 子 菜 单
content += loadchild(item);
// 结 束 一 个 根 菜 单 项
content += '</li>';
menuHtml += content;
});
// 结 束 菜 单 结 构 的 初 始 化
menuHtml += "</ul></div>";
// 将 菜 单 拼 接 到 初 始 化 容 器 中
layui.$("#" + option.elem).html(menuHtml);
}
// 创建多系统菜单, 包括渲染静态html和绑定顶部菜单点击事件
function createMenuAndControl(option) {
var control = '<ul class="layui-nav laytp-nav-control pc layui-hide-xs">';
var controlPe = '<ul class="layui-nav laytp-nav-control layui-hide-sm">';
// 声 明 头 部
var menu = '<div class="layui-side-scroll ' + option.theme + '">';
// 开 启 同 步 操 作
var index = 0;
var controlItemPe = '<dl class="layui-nav-child">';
var config = layui.apidoc.readConfig();
$.each(option.data, function(i, item) {
var menuItem = '';
var controlItem = '';
if(index < config.menu['maxTopMenuNum']){
if (i === option.defaultMenu) {
controlItem = '<li menu-title="' + item.title + '" doc-type="' + item.docType + '" menu-id="' + item.id +
'" class="layui-this layui-nav-item"><a href="javascript:void(0);">' + item.title + '</a></li>';
menuItem = '<ul menu-id="' + item.id + '" lay-filter="' + option.elem +
'" class="layui-nav arrow laytp-menu layui-nav-tree laytp-nav-tree">';
// 兼容移动端
controlPe += '<li class="layui-nav-item"><a class="pe-title" href="javascript:void(0);" >' + item.title + '</a>';
controlItemPe += '<dd menu-title="' + item.title + '" menu-id="' + item.id +
'"><a href="javascript:void(0);">' + item.title + '</a></dd>';
} else {
controlItem = '<li menu-title="' + item.title + '" doc-type="' + item.docType + '" menu-id="' + item.id +
'" class="layui-nav-item"><a href="javascript:void(0);">' + item.title + '</a></li>';
menuItem = '<ul style="display:none" menu-id="' + item.id + '" lay-filter="' + option.elem +
'" class="layui-nav arrow layui-nav-tree laytp-nav-tree">';
controlItemPe += '<dd menu-title="' + item.title + '" doc-type="' + item.docType + '" menu-id="' + item.id +
'"><a href="javascript:void(0);">' + item.title + '</a></dd>';
}
index++;
}else{
menuItem = '<ul style="display:none" menu-id="' + item.id + '" lay-filter="' + option.elem +
'" class="layui-nav arrow layui-nav-tree laytp-nav-tree">';
controlItemPe += '<dd menu-title="' + item.title + '" doc-type="' + item.docType + '" menu-id="' + item.id +
'"><a href="javascript:void(0);">' + item.title + '</a></dd>';
index++;
}
$.each(item.children, function(i, note) {
// 创 建 每 一 个 菜 单 项
var content = '<li class="layui-nav-item" >';
var href = "javascript:void(0);";
var target = "";
var className = "site-demo-active";
if (note.openType == "_blank" && note.type == 1) {
href = note.href;
target = "target='_blank'";
className = "";
}
// 判 断 菜 单 类 型 0 是 不可跳转的目录 1 是 可 点 击 跳 转 的 菜 单
if (note.type == 0) {
// 创 建 目 录 结 构
content += '<a href="javascript:void(0);" menu-type="' + item.type + '" doc-type="' + note.docType + '" menu-id="' + note.id +
'" ><span>' + note.title +
'</span></a>';
} else if (note.type == 1) {
// 创 建 菜 单 结 构
content += '<a class="' + className + '" menu-type="' + item.type + '" doc-type="' + note.docType + '" menu-id="' + note.id +
'" menu-title="' + note.title + '" href="' + href + '"><span>' + note.title + '</span></a>';
}
content += loadchild(note);
content += '</li>';
menuItem += content;
})
menu += menuItem + '</ul>';
control += controlItem;
})
if(option.data.length > config.menu['maxTopMenuNum']){
control += '<li class="layui-nav-item">\n' +
'<a href="javascript:void(0);" class="laytp-icon laytp-icon-elipsis"></a>' +
'<!-- 功 能 菜 单 -->\n' +
'<dl class="layui-nav-child">';
var moreTopMenuIndex = 0;
$.each(option.data, function(i, item) {
var moreTopMenuItem = '';
if(moreTopMenuIndex >= config.menu['maxTopMenuNum']){
moreTopMenuItem = '<dd><a menu-title="' + item.title + '" menu-id="' + item.id +'">' + item.title + '</a></dd>';
}
moreTopMenuIndex++;
control += moreTopMenuItem;
});
control += '</dl></li></ul>';
}
controlItemPe += "</li></dl></ul>";
controlPe += controlItemPe;
layui.$("#" + option.control).html(control);
layui.$("#" + option.control).append(controlPe);
layui.$("#" + option.elem).html(menu);
// 绑定顶部菜单点击事件
layui.$(document).off("click", "#" + option.control + " .laytp-nav-control [menu-id]").on("click", "#" + option.control + " .laytp-nav-control [menu-id]", function() {
// layui.$("#" + option.control + " .laytp-nav-control").on("click", "[menu-id]", function() {
layui.$("#" + option.elem).find(".laytp-nav-tree").css({
display: 'none'
});
layui.$("#" + option.elem).find(".laytp-nav-tree[menu-id='" + layui.$(this).attr("menu-id") + "']").css({
display: 'block'
});
layui.$("#" + option.control).find(".pe-title").html(layui.$(this).attr("menu-title"));
layui.$("#" + option.control).find("");
option.change(layui.$(this).attr("menu-id"), layui.$(this).attr("menu-title"), layui.$(this).attr("menu-href"));
// 自动点击左侧的第一个菜单
var s = layui.$("a:first",layui.$("#" + option.elem).find("ul[style='display: block;']")).parent();
if(s.hasClass("layui-nav-itemed")){
recursionFindA(s);
}else{
layui.$("a:first",layui.$("#" + option.elem).find("ul[style='display: block;']")).click();
}
});
}
// 点击顶部菜单,自动点击左侧菜单,当菜单已经是展开状态时,要递归找到最低级别的A标签进行点击
function recursionFindA(obj){
var dlObj = layui.$("dl:first", obj);
if(dlObj.length === 0){
layui.$("a:first", obj).click();
}else{
recursionFindA(layui.$("dd:first",dlObj));
}
}
/** 加载子菜单 (递归)*/
function loadchild(obj) {
// 判 单 是 否 是 菜 单, 如 果 是 菜 单 直 接 返 回
if (obj.type == 1) {
return "";
}
// 创 建 子 菜 单 结 构
var content = '<dl class="layui-nav-child">';
// 如 果 嵌 套 不 等 于 空
if (obj.children != null && obj.children.length > 0) {
// 遍 历 子 项 目
$.each(obj.children, function(i, note) {
// 创 建 子 项 结 构
content += '<dd>';
var href = "javascript:;";
var target = "";
var className = "site-demo-active";
if (note.openType == "_blank" && note.type == 1) {
href = note.href;
target = "target='_blank'";
className = "";
}
// 判 断 子 项 类 型
if (note.type == 0) {
// 创 建 目 录 结 构
content += '<a href="' + href + '" doc-type="' + note.docType + '" menu-id="' + note.id +
'"><i class="' + note.icon + '"></i><span>' + note.title + '</span></a>';
} else if (note.type == 1) {
// 创 建 菜 单 结 构
content += '<a class="' + className + '" doc-type="' + note.docType + '" menu-id="' + note.id + '" menu-title="' + note.title + '" href="' + href +
'" ><i class="' + note.icon + '"></i><span>' + note.title + '</span></a>';
}
// 加 载 子 项 目 录
content += loadchild(note);
// 结 束 当 前 子 菜 单
content += '</dd>';
});
// 封 装
} else {
content += '<div class="toast"> 无 内 容 </div>';
}
content += '</dl>';
return content;
}
// 左侧菜单点击事件
function downShow(option) {
layui.$(document).off("click", "#" + option.elem + " a[menu-type='0']").on("click", "#" + option.elem + " a[menu-type='0']", function() {
// layui.$("body #" + option.elem).on("click", "a[menu-type='0']", function() {
if (!layui.$("#" + option.elem).is(".laytp-nav-mini")) {
var superEle = layui.$(this).parent();
var ele = layui.$(this).next('.layui-nav-child');
var heights = ele.children("dd").length * 48;
if (superEle.is(".layui-nav-itemed")) {
if (option.accordion) {
superEle.parent().find(".layui-nav-itemed").removeClass("layui-nav-itemed");
superEle.addClass("layui-nav-itemed");
//自动点击第一个子菜单
layui.$("a:first",ele).click();
}
ele.height(0);
ele.animate({
height: heights + "px"
}, 200, function() {
ele.css({
height: "auto"
});
});
} else {
superEle.addClass("layui-nav-itemed");
ele.animate({
height: "0px"
}, 200, function() {
ele.css({
height: "auto"
});
superEle.removeClass("layui-nav-itemed");
});
}
}
})
}
/** 二 级 悬 浮 菜 单*/
function isHoverMenu(b, option) {
if (b) {
layui.$("#" + option.elem + ".laytp-nav-mini .layui-nav-item,#" + option.elem + ".laytp-nav-mini dd").hover(function(e) {
e.stopPropagation();
var _this = layui.$(this);
_this.siblings().find(".layui-nav-child")
.removeClass("layui-nav-hover").css({
left: 0,
top: 0
});
_this.children(".layui-nav-child").addClass("layui-nav-hover");
_this.closest('.layui-nav-item').data('time') && clearTimeout(_this.closest('.layui-nav-item').data('time'));
var height = layui.$(window).height();
var topLength = _this.offset().top;
var thisHeight = _this.children(".layui-nav-child").height();
if ((thisHeight + topLength) > height) {
topLength = height - thisHeight - 10;
}
var left = _this.offset().left + 60;
if (!_this.hasClass("layui-nav-item")) {
left = _this.offset().left + _this.width();
}
_this.children(".layui-nav-child").offset({
top: topLength,
left: left + 3
});
}, function(e) {
e.stopPropagation();
var _this = layui.$(this);
_this.closest('.layui-nav-item').data('time', setTimeout(function() {
_this.closest('.layui-nav-item')
.find(".layui-nav-child")
.removeClass("layui-nav-hover")
.css({
left: 0,
top: 0
});
}, 50));
})
} else {
layui.$("#" + option.elem + " .layui-nav-item").off('mouseenter').unbind('mouseleave');
layui.$("#" + option.elem + " dd").off('mouseenter').unbind('mouseleave');
}
}
exports(MOD_NAME, new laytpApiMenu());
});
@@ -0,0 +1,89 @@
layui.use(["laytp"], function () {
const funController = {};
//静态页面地址前缀
window.htmlPrefix = facade.compatibleHtmlPath("/plugin/apidoc/");
//后端接口地址前缀
window.apiPrefix = facade.compatibleApiRoute("/plugin/apidoc/index/");
//表格渲染
funController.tableRender = function (where, page) {
layui.table.render({
elem: "#laytp-table"
, id: "laytp-table"
, url: facade.url("/plugin/apidoc/index/index",{paging:1})
, toolbar: "#default-toolbar"
, defaultToolbar: [{
title: '刷新',
layEvent: 'refresh',
icon: 'layui-icon-refresh',
}, 'filter', 'print', 'exports']
, where: where
, method: "GET"
, cellMinWidth: 120
, skin: 'line'
, loading: false
, page: {
curr: page
}
, parseData: function (res) { //res 即为原始返回的数据
return facade.parseTableData(res, true);
}
, done: function(){
layui.laytpTable.done();
}
, cols: [[
{type: 'checkbox', fixed: 'left'}
, {field: 'id', title: 'ID', align: 'center', width: 80, fixed: 'left'}
, {field: 'title', title: '标题', align: 'center'}
, {field: 'des', title: '描述', align: 'center'}
, {field: 'create_time', title: '创建时间', align: 'center'}
, {field:'operation',title:'操作',align:'center',toolbar:'#default-bar',width:150,fixed:'right'}
]]
});
//监听数据表格顶部左侧按钮点击事件
layui.table.on("toolbar(laytp-table)", function (obj) {
//默认按钮点击事件,包括添加按钮和回收站按钮
var defaultTableToolbar = layui.context.get("defaultTableToolbar");
if (defaultTableToolbar.indexOf(obj.event) !== -1) {
laytp.tableToolbar(obj);
//其他自定义按钮点击事件
} else {
//自定义按钮点击事件
switch (obj.event) {
//生成Api文档
case "create":
facade.ajax({
route: "/plugin/apidoc/index/create",
showLoading: true
});
break;
//查看Api文档
case "open":
window.open(facade.getAdminApiDomain() + "/api.html");
break;
}
}
});
//监听数据表格[操作列]按钮点击事件
layui.table.on("tool(laytp-table)", function (obj) {
var defaultTableTool = layui.context.get("defaultTableTool");
if (defaultTableTool.indexOf(obj.event) !== -1) {
laytp.tableTool(obj);
} else {
// //自定义按钮点击事件
// switch(obj.event){
// //自定义按钮点击事件
// case "":
//
// break;
// }
}
});
};
funController.tableRender();
window.funController = funController;
});
@@ -0,0 +1,78 @@
layui.use(['laytp'], function () {
const funRecycleController = {};
//静态页面地址前缀
window.htmlPrefix = facade.compatibleHtmlPath("/plugin/apidoc/");
//后端接口地址前缀
window.apiPrefix = facade.compatibleApiRoute("/plugin/apidoc/index/");
//表格渲染
funRecycleController.tableRender = function (where, page) {
layui.table.render({
elem: "#laytp-recycle-table"
, id: "laytp-recycle-table"
, url: facade.url("/plugin/apidoc/index/recycle")
, toolbar: "#recycle-default-toolbar"
, defaultToolbar: [{
title: '刷新',
layEvent: 'recycle-refresh',
icon: 'layui-icon-refresh',
}, 'filter', 'print', 'exports']
, where: where
, method: "GET"
, cellMinWidth: 80
, skin: 'line'
, loading: false
, page: {
curr: page
}
, parseData: function (res) { //res 即为原始返回的数据
return facade.parseTableData(res, true);
}
, cols: [[ //表头
{type: 'checkbox', fixed: 'left'}
, {field: 'id', title: 'ID', align: 'center', width: 80, fixed: 'left'}
, {field: 'title', title: '标题', align: 'center'}
, {field: 'des', title: '描述', align: 'center'}
, {field: 'create_time', title: '创建时间', align: 'center'}
, {field:'operation',title:'操作',align:'center',toolbar:'#recycle-default-bar',width:150,fixed:'right'}
]]
});
//监听数据表格顶部左侧按钮点击事件
layui.table.on("toolbar(laytp-recycle-table)", function (obj) {
var defaultTableToolbar = layui.context.get("defaultTableToolbar");
if (defaultTableToolbar.indexOf(obj.event) !== -1) {
//默认按钮点击事件
laytp.tableToolbar(obj);
} else {
// //自定义按钮点击事件
// switch(obj.event){
// //自定义按钮点击事件
// case "":
//
// break;
// }
}
});
//监听数据表格[操作列]按钮点击事件
layui.table.on('tool(laytp-recycle-table)', function (obj) {
var defaultTableTool = layui.context.get("defaultTableTool");
if (defaultTableTool.indexOf(obj.event) !== -1) {
laytp.tableTool(obj);
} else {
// //自定义按钮
// switch(obj.event){
// //自定义按钮点击事件
// case '':
//
// break;
// }
}
});
};
funRecycleController.tableRender();
window.funRecycleController = funRecycleController;
});
+102
View File
@@ -0,0 +1,102 @@
<?php
/**
* mdeditor上传图片接口
*/
namespace plugin\meditor\controller;
use app\service\ConfServiceFacade;
use laytp\library\UploadDomain;
use plugin\ali_oss\service\Oss;
use plugin\qiniu_kodo\service\Kodo;
use laytp\controller\Backend;
use think\facade\Env;
use think\facade\Filesystem;
class Common extends Backend
{
protected $noNeedLogin = ['*'];
//上传接口
public function upload()
{
try {
$uploadType = $this->request->param('upload_type', 'local');
$file = $this->request->file('editormd-image-file'); // 获取上传的文件
if (!$file) {
return $this->error('上传失败,请选择需要上传的文件');
}
$fileExt = strtolower($file->getOriginalExtension());
$uploadDomain = new UploadDomain();
if (!$uploadDomain->check($file->getOriginalName(), $file->getSize(), $fileExt, $file->getMime())) {
return $this->error($uploadDomain->getError());
}
$saveName = date("Ymd") . "/" . md5(uniqid(mt_rand())) . ".{$fileExt}";
/**
* 不能以斜杆开头
* - 因为OSS存储时,不允许以/开头
*/
$uploadDir = $this->request->param('dir');
$object = $uploadDir ? $uploadDir . '/' . $saveName : $saveName;//设置了上传目录的上传文件名
$inputValue = "";
//上传至七牛云
if ($uploadType == 'qiniu-kodo') {
if(ConfServiceFacade::get('qiniuKodo.conf.switch') != 1){
return $this->error('未开启七牛云KODO存储,请到七牛云KODO配置中开启');
}
$kodoConf = [
'accessKey' => ConfServiceFacade::get('qiniuKodo.conf.accessKey'),
'secretKey' => ConfServiceFacade::get('qiniuKodo.conf.secretKey'),
'bucket' => ConfServiceFacade::get('qiniuKodo.conf.bucket'),
'domain' => ConfServiceFacade::get('qiniuKodo.conf.domain'),
];
$kodo = Kodo::instance();
$kodoRes = $kodo->upload($file->getPathname(), $object, $kodoConf);
if ($kodoRes) {
$inputValue = $kodoRes;
} else {
return $this->error($kodo->getError());
}
}
//上传至阿里云
if ($uploadType == 'ali-oss') {
if(ConfServiceFacade::get('system.aliOss.switch') != 1){
return $this->error('未开启阿里云OSS存储,请到阿里云OSS配置中开启');
}
$ossConf = [
'accessKeyID' => ConfServiceFacade::get('aliOss.conf.accessKeyID'),
'accessKeySecret' => ConfServiceFacade::get('aliOss.conf.accessKeySecret'),
'bucket' => ConfServiceFacade::get('aliOss.conf.bucket'),
'endpoint' => ConfServiceFacade::get('aliOss.conf.endpoint'),
'domain' => ConfServiceFacade::get('aliOss.conf.domain'),
];
$oss = Oss::instance();
$ossUploadRes = $oss->upload($file->getPathname(), $object, $ossConf);
if ($ossUploadRes) {
$inputValue = $ossUploadRes;
} else {
return $this->error($oss->getError());
}
}
//本地上传
if ($uploadType == 'local') {
$uploadDir = ltrim('/', $uploadDir);
$saveName = Filesystem::putFileAs('/' . $uploadDir, $file, '/' . $object);
$staticDomain = Env::get('domain.static');
if ($staticDomain) {
$inputValue = $staticDomain . '/storage/' . $saveName;
} else {
$inputValue = request()->domain() . '/static/storage/' . $saveName;
}
}
return json(['url' => $inputValue, 'success' => 1]);
} catch (\Exception $e) {
return $this->exceptionError($e);
}
}
}
+9
View File
@@ -0,0 +1,9 @@
name = meditor
title = MEditor
description = MEditor编辑器
version = 1.0.0
author = Laytp官方
lt_version = 2.0.0
parent_menu = first
menu_ids =
is_editor = 1
+118
View File
@@ -0,0 +1,118 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LayTp极速后台开发框架MEditor编辑器</title>
<script>
if(localStorage.getItem("staticDomain")){
document.write("<link rel='stylesheet' href='" + localStorage.getItem("staticDomain") + "/plugin/meditor/css/editormd.css?v="+localStorage.getItem("version")+"'>");
document.write("<script type=\"text/javascript\" src='" + localStorage.getItem("staticDomain") + "/component/jquery_3.3.1.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script type=\"text/javascript\" src='" + localStorage.getItem("staticDomain") + "/plugin/meditor/editormd.js?v="+localStorage.getItem("version")+"'><\/script>");
}else{
document.write("<link rel='stylesheet' href='/static/plugin/meditor/css/editormd.css?v="+localStorage.getItem("version")+"'>");
document.write("<script type=\"text/javascript\" src='/static/component/jquery_3.3.1.js?v="+localStorage.getItem("version")+"'><\/script>");
document.write("<script type=\"text/javascript\" src='/static/plugin/meditor/editormd.js?v="+localStorage.getItem("version")+"'><\/script>");
}
</script>
<style>
body {
padding: 0;
margin: 0;
}
</style>
</head>
<body>
<div class="editor" id="meditorMeditor" name="meditorMeditor"></div>
<script>
/**
* 获取Url中传递的参数值
* @param name 参数名
* @returns {string}
*/
function getUrlParam(name) {
let sear = window.location.search.substr(1);
let reg = new RegExp("(^|&)" + name + "=([^&]*)(&|$)");
let r = sear.match(reg);
return r ? sear.match(reg)[2] : "";
}
/**
* 如下两句为了渲染编辑页面,编辑器的内容
*/
let id = getUrlParam('id');
// 得到url中传递的val,val的值就是编辑页面需要渲染编辑器内容的值
let editorVal = $('.editorContent[data-id="'+id+'"]', window.parent.document).text();
// 得到url中传递的upload_typeupload_type的值就是编辑器的文件上传方式
let uploadType = getUrlParam('upload_type');
// 编辑器的文件上传方式如果没有设置,默认使用local,本地上传方式
if(!uploadType){
uploadType = 'local';
}
// 验证upload_type的值,目前仅允许设置成local ali-oss qiniu-kodo三种中的一种
if(uploadType !== 'local' && uploadType !== 'ali-oss' && uploadType !== 'qiniu-kodo'){
console.log('编辑器的文件上传方式错误');
}
// 根据上传方式和是否多域名配置的不同,设置编辑器的配置 imageUploadURL
var imageUploadURL = '';
if(uploadType === 'local'){
if(localStorage.getItem("adminApiDomain")){
imageUploadURL = localStorage.getItem("adminApiDomain") + '/plugin/meditor/common/upload/accept/file/dir/meditor';
}else{
imageUploadURL = '/plugin/meditor/common/upload/accept/file/dir/meditor';
}
}else if(uploadType === 'ali-oss'){
if(localStorage.getItem("adminApiDomain")){
imageUploadURL = localStorage.getItem("adminApiDomain") + '/plugin/meditor/common/upload/accept/file/dir/meditor/upload_type/ali-oss';
}else{
imageUploadURL = '/plugin/meditor/common/upload/accept/file/dir/meditor/upload_type/ali-oss';
}
}else if(uploadType === 'qiniu-kodo'){
if(localStorage.getItem("adminApiDomain")){
imageUploadURL = localStorage.getItem("adminApiDomain") + '/plugin/meditor/common/upload/accept/file/dir/meditor/upload_type/qiniu-kodo';
}else{
imageUploadURL = '/plugin/meditor/common/upload/accept/file/dir/meditor/upload_type/qiniu-kodo';
}
}
// 根据是否多域名配置,设置编辑器的配置 path
var path = '';
if(localStorage.getItem("staticDomain")){
path = localStorage.getItem("staticDomain") + '/plugin/meditor/lib/';
}else{
path = '/static/plugin/meditor/lib/';
}
window.me = editormd("meditorMeditor", {
autoFocus: false,
saveHTMLToTextarea: true,
name: name,
value: editorVal,
width: "99%",
zIndex: 0,
height: 558,
syncScrolling: "single",
path: path,
taskList: true,
tex: true, // 默认不解析
flowChart: true, // 默认不解析
sequenceDiagram: true, // 默认不解析
imageUpload: true,
imageFormats: ["jpg", "jpeg", "gif", "png", "bmp", "webp", "JPG", "JPEG", "GIF", "PNG", "BMP", "WEBP"],
imageUploadURL: imageUploadURL,
});
window.getEditorContent = function () {
return window.me.getMarkdown();
}
window.getHtmlContent = function(){
return $("#meditorMeditor .markdown-body.editormd-preview-container").html();
// return window.me.getHTML();
}
</script>
</body>
</html>
@@ -0,0 +1,15 @@
logs
*.log
*.pid
*.seed
node_modules/
.sass-cache/
research/
test/
backup/
examples/uploads/**/*
*.bat
*.sh
.project
.url
css/*.map
@@ -0,0 +1,20 @@
{
"esnext": true,
"bitwise": true,
"camelcase": true,
"curly": true,
"eqeqeq": true,
"immed": true,
"indent": 4,
"latedef": true,
"newcap": true,
"noarg": true,
"quotmark": "double",
"regexp": true,
"undef": true,
"unused": true,
"strict": true,
"trailing": true,
"smarttabs": true,
"white": true
}
@@ -0,0 +1,22 @@
#Bugs
> 说明:删除线表示已经解决。
####IE8
- ~~不能加载;~~
- flowChart(流程图)、sequenceDiagram(序列图)不支持IE8
- ~~不支持Markdown转HTML页面解析预览;~~
####IE8 & IE9 & IE10
- KaTeX会出现解析错误,但不影响程序运行;
####Sea.js
- ~~Raphael.js无法加载;~~
####Require.js
- ~~CodeMirror编辑器的代码无法高亮;~~
- ~~sequenceDiagram不支持: `Uncaught TypeError: Cannot call method 'isArray' of undefined.`~~
@@ -0,0 +1,534 @@
## 更新日志
### v1.0.x
##### v1.0.0 beta
预览版:基本功能完成;
##### v1.0.0 releases
发布 v1.0.0 正式版。
主要更新:
- 新建分支 `mathjax-version`,但不打算继续对此分支进行开发;
- 移除 MathJax,改用 KaTeX [#2](https://github.com/pandao/editor.md/issues/2),解析和预览响应速度大幅度提高 [#3](https://github.com/pandao/editor.md/issues/3)
- 移除 `mathjax` 配置项;
- 移除 `mathjaxURL` 属性;
- 移除 `setMathJaxConfig()` 方法;
- 移除 `loadMathJax()` 方法;
- 移除MathJax的所有示例;
- 新增 `tex` 配置项,表示是否开启支持科学公式 TeX ,基于 KaTeX;
- 新增 `katexURL` 属性;
- 新增 `loadKaTeX` 方法;
- 新增 KaTeX 的示例;
- `setCodeEditor()` 方法更名为 `setCodeMirror()`
- 合并 CodeMirror 使用到的多个 JS 模块文件,大幅减少 HTTP 请求,加快下载速度;
- 新增合并后的两个模块文件:`./lib/codemirror/modes.min.js``./lib/codemirror/addons.min.js`
- `Gulpfile.js` 新增合并 CodeMirror 模块文件的任务方法 `codemirror-mode``codemirror-addon`
- 另外在使用 Require.js 时,因为 CodeMirror 的严格模块依赖的限制,不能使用上述合并的模块文件,仍然采用动态加载多个模块文件;
- 更新 `README.md` 等相关文档和示例;
- 解决 Sea.js 环境下 Raphael.js 无法运行导致不支持流程图和时序图的问题,即必须先加载 Raphael.js ,后加载 Sea.js
### v1.1.x
##### v1.1.0
主要更新:
- 设计并更换了 Logo
- 新增添加图片、链接、锚点链接、代码块、预格式文本等操作弹出对话框层及示例;
- 新增支持图片(跨域)上传;
- 改用 `<textarea>` 来存放 Markdown 源文档;
- 新增支持自定义工具栏;
- 新增支持多语言;
- 新增支持 Zepto.js
- 新增支持多个 Editor.md 并存和动态加载 Editor.md 及示例;
- 新增支持智能识别和解析 HTML 标签及示例;
- 新增多个外部操作方法接口及示例;
- 修复了一些大大小小的 Bug
具体更新如下:
- 更换 Logo,建立基础 VI
- 创建了全系列 WebFont 字体 `dist/fonts/editormd-logo.*`
- 新增样式类 `editormd-logo` 等;
- 改用 `<textarea>` 来存放 Markdown 源文档;
- 原先使用 `<script type="text/markdown"></script>` 来存放 Markdown 源文档;
- 创建 Editor.md 只需要写一个 `<div id="xxxx"></div>` ,如果没有添加 `class="editormd"` 属性会自动添加,另外如果不存在 `<textarea>` 标签,则也会自动添加 `<textarea>`
- 新增支持智能识别和解析 HTML 标签,增强了 Markdown 语法的扩展性,几乎无限,例如:插入视频等等;
- 新增配置项 `htmlDecode` ,表示是否开启 HTML 标签识别和解析,但是为了安全性,默认不开启;
- 新增识别和解析 HTML 标签的示例;
- 新增插入链接、锚点链接、预格式文本和代码块的弹出对话框层;
- 弹出层改为使用固定定位;
- 新增动态创建对话框的方法 `createDialog()`
- 新增静态属性 `editormd.codeLanguages` ,用于存放代码语言列表;
- 开始支持图片上传;
- 新增添加图片(上传)弹出对话框层;
- 支持基于 iframe 的跨域上传,并添加相应的示例( PHP 版);
- 开始支持自定义工具栏图标及操作处理;
- 配置项 `toolbarIcons` 类型由数组更改为函数,返回一个图标按钮列表数组;
- 新增配置项 `toolbarHandlers``toolbarIconsTexts` ,分别用于自定义按钮操作处理和按钮内容文本;
- 新增方法 `getToolbarHandles()` ,用于可在外部使用默认的操作方法;
- 新增成员属性 `activeIcon` ,可获取当前或上次点击的工具栏图标的 jQuery 实例对象;
- 新增表单取值、自定义工具栏、图片上传、多个 Editor.md 并存和动态加载 Editor.md 等多个示例;
- 新增插入锚点按钮和操作处理;
- 新增预览 HTML 内容窗口的关闭按钮,之前只能按 ESC 才能退出 HTML 全窗口预览;
- 新增多语言( l18n )及动态加载语言包支持;
- 新增英语 `en` 和繁体中文 `zh-tw` 语言包模块;
- 修改一些方法的内部实现以支持动态语言加载:
- `toolbarHandler()` 更为 `setToolbarHandler()`
- `setToolbar()` 方法包含 `setToolbarHandler()`
- 新建 `createInfoDialog()` 方法;
- 修改 `showInfoDialog()``hideInfoDialog()` 方法的内部实现等;
- 修改多次 Bug ,并优化触摸事件,改进对 iPad 的支持;
- 工具栏新增清空按钮和清空方法 `clear()` ,解决工具栏文本会被选中出现蓝底的问题;
- 配置项 `tocStartLevel` 的默认值由 2 改为 1,表示默认从 H1 开始生成 ToC;
- 解决 IE8 下加载出错的问题;
- 新增两个静态成员属性 `isIE``isIE8` ,用于判断 IE8
- 由于 IE8 不支持 FlowChart 和 SequenceDiagram,默认在 IE8 下不加载这两个组件,无论是否开启;
- 新增 Zepto.js 的支持;
- 为了兼容 Zepto.js ,某些元素在操作处理上不再使用 `outerWidth()``outerHeight()``hover()``is()` 等方法;
- 为了避免修改 flowChart.js 和 sequence-diagram.js 的源码,所以想支持 flowChart 或 sequenceDiagram 得加上这一句: `var jQuery = Zepto;`
- 新增 `editormd.$name` 属性,修改 `editormd.homePage` 属性的新地址;
- `editormd.markdownToHTML()` 新增方法返回一个 jQuery 实例对象;
- 该实例对象定义了一个 `getMarkdown()`方法,用于获取 Markdown 源代码;
- 该实例对象定义了一个 `tocContainer` 成员属性,即 ToC 列表的父层的 jQuery 实例对象;
- 新增只读模式;
- 新增配置项 `readOnly` ,默认值为 `false` ,即可编辑模式;
- 其他相关改动;
- 新增方法 `focus()``setCursor()``getCursor()``setSelection()``getSelection()``replaceSelection()``insertValue()` 方法,并增加对应的示例;
- 新增配置项 `saveHTMLToTextarea` ,用于将解析后的 HTML 保存到 Textarea,以供提交到后台程序;
- `getHTML()` 方法必须在 `saveHTMLToTextarea == true` 的情况下才能使用;
- 新增 `getHTML()` 方法的别名 `getTextareaSavedHTML()` 方法;
- 新增方法 `getPreviewedHTML()` ,用于获取预览窗口的 HTML
- 修复了一些大大小小的 Bugs
##### v1.1.1
- 接受一个 pull 请求,修复了 `getHTML ()``getPreviewedHTML()` 方法中的 处错误;
##### v1.1.2
- 修复 Bug [10](https://github.com/pandao/editor.md/issues/10)
- 修复 Bug [12](https://github.com/pandao/editor.md/issues/12)
##### v1.1.3
- 修复 Bug [14](https://github.com/pandao/editor.md/issues/14)
- 修复 Bug [15](https://github.com/pandao/editor.md/issues/15)
##### v1.1.4
- 修复 Bug [17](https://github.com/pandao/editor.md/issues/17)
- 修改了 `getToolbarHandles()``setToolbarHandler()` 方法;
-`editormd.scss` 中分离出 `editormd.logo.scss` ,并生成 `editormd.logo.css` ,以便单独使用;
- 同时修改了 `Gulpfile.js` 的相应任务;
##### v1.1.5
- 修复 Bug [18](https://github.com/pandao/editor.md/issues/18)
- 修改了 `showInfoDialog()``createInfoDialog()` 方法;
- 新增 `infoDialogPosition()` 方法;
- 修复 Bug [20](https://github.com/pandao/editor.md/issues/20)
- 修改了引用的处理函数;
- 插入的 headers 的 `#` 号后面都加上了一个空格;
##### v1.1.6
修复多处 Bug,具体如下:
- 修复 Bug [#23](https://github.com/pandao/editor.md/issues/23),即 Headers 的 id 属性的重复及中文问题;
- 修改了 `editormd.markedRenderer()` 方法;
- 修复 Bug [#24](https://github.com/pandao/editor.md/issues/24)
- 修改了 `setMarkdown()``clear()``loadedDisplay()` 方法的内部实现;
- 新增了 `katexRender()``flowChartAndSequenceDiagramRender()``previewCodeHighlight()` 方法;
- 修复有些情况下无法保存 Markdown 源文档到 textarea 的问题;
- 修改了 `setCodeMirror()``recreateEditor()` 等方法;
- 修改了以上 Bug 及部分相关示例文件;
##### v1.1.7
修复多处 Bug,具体如下:
- 修复 Bug [#25](https://github.com/pandao/editor.md/issues/25)
- 修改了 `loadedDisplay()` 方法,将 `settings.onload` 移动了 `CodeMirror.on("change")` 事件注册后再触发;
- 修复 Bug [#26](https://github.com/pandao/editor.md/issues/26)
- 修改了 `saveToTextareas()` 方法;
- 新增 `state.loaded``state.watching` 两个属性;
- 修改了以上 Bug 相关示例文件;
##### v1.1.8
改进功能,具体如下:
- 改进 [#27](https://github.com/pandao/editor.md/issues/27)
- 新增配置项 `matchWordHighlight` ,可选值有: `true, false, "onselected"` ,默认值为 `true` ,即开启自动匹配和标示相同单词;
- 改进 [#28](https://github.com/pandao/editor.md/issues/28)
-`jquery.min.js``font-awesome.min.css``github-markdown.css` 移除(这是一个疏忽,它们不是动态加载的依赖模块或者不需要的,避免不必要的硬盘空间占用);
- 修改了所有相关的示例文件;
##### v1.1.9
- 修复无法解析 heading link 的 Bug [#29](https://github.com/pandao/editor.md/issues/29)
- 修改了 `editormd.markedRenderer()` 方法的内部实现;
- 新增了 `editormd.trim()` ,用于清除字符串两边的空格;
- 修改了所有相关的示例文件和测试用例 `marked-heading-link-test.html`
- 修改了 `README.md` ,添加了 `Shields.io` 图标;
### v1.2
##### v1.2.0
v1.2.0 主要更新:
- 新增代码折叠、搜索替换、自定义样式主题和自定义快捷键等功能;
- 新增 Emoji 表情、@Link 、GFM Task Lists 支持;
- 新增表格插入、Emoji 表情插入、HTML 实体字符插入、使用帮助等对话框;
- 新增插件扩展机制;
- 新增手动加载依赖模块方式;
- 改用 `Prefixes.css` 作 CSS 前缀预处理;
- 改进和增强工具栏自定义功能,完善事件监听和处理方法;
- 部分功能改进(更加方便的预格式文本/代码插入、自动闭合标签等)、新增多个方法、改进 Require.js 支持和修复多个 Bug 等等;
**具体更新如下:**
- 新建 v1.1.x 分支;
- v1.2 文件结构变动较大;
- 新增代码折叠、自动闭合标签和搜索替换功能;
- 搜索快捷键 `Ctrl + F / Command + F`
- 替换快捷键 `Ctrl + Shift + F / Command + Option + F`
- 折叠快捷键 `Ctrl + Q / Command + Q`
- 新增自定义主题支持;
- 新增 3 个成员方法 `setTheme()``setCodeMirrorOption()``getCodeMirrorOption()`
- 新增 @Link 支持;
- 新增 GFM Task Lists 支持;
- 新增 Emoji 表情支持;
- 支持 Github emoji `:emoji-name:` 、FontAwesome icons`:fa-xxx:`)、Twitter emoji (twemoji) `:tw-xxxx:` )、Editor.md logo icons `:editormd-logo:` )形式的 Emoji
- 新增属性 `editormd.emoji``editormd.twemoji``editormd.urls``editormd.regex`
- 新增 HTML 实体字符插入、插入表格和使用帮助对话框;
- 修改了 `createDialog()` 等方法;
- 新增 `mask` 成员属性和锁屏方法 `editormd.lockScreen()``editormd.fn.lockScreen()`
- 改进插入预格式文本和代码对话框;
-`<textarea>` 改为 `CodeMirror` ,输入更加方便和直观;
- 新增自定义键盘快捷键功能;
- 新增 2 个方法: `addKeyMap()``removeKayMap()`
- 改用 `Prefixes.css` 作CSS前缀预处理;
- SCSS前缀预处理mixins改用 [Prefixes.scss](https://github.com/pandao/prefixes.scss "Prefixes.scss")
- 改进和增强工具栏自定义功能;
- 新增配置项 `toolbarCustomIcons` ,用于增加自定义工具栏的功能,可以直接插入 HTML 标签,不使用默认的元素创建图标;
- 新增工具栏列表预设值属性 `editormd.toolbarModes`
- 移除成员属性 `toolbarIconHandlers`
- 完善和新增事件处理方法;
- 新增事件回调注册方法 `on()`
- 新增事件回调移除方法 `off()`
- 新增事件回调处理配置项: `onresize``onscroll``onpreviewscroll``onpreviewing``onpreviewed``onwatch``onunwatch`
- 新增手动加载依赖模块方式,以便可同步使用成员方法;
- 新增属性 `autoLoadModules` ,默认值为 `true`
- 新增插件及扩展机制;
- 新增插件自定义机制,改变整体结构(包括文件结构),以便更加方便地实现插件扩展;
- 新增对象扩展方法 `extends()``set()`
- 新增成员方法和属性:
- 新增两个方法: `setValue()``getValue()`
- 新增 `config()` 方法,用于加载后重新配置;
- 增加两个属性 `cm` ,是 `codeEditor` 的简写, `cmElement``codeMirror` 的别名;
- 成员方法的改进:
- 改进: `showToolbar()``hideToolbar()` 方法增加一个 `callback` 函数,用于直接回调操作;
- 改进:修改了 `previewCodeHighlight()` 方法;
- 更名: `recreateEditor()` 更名为 `recreate()`
- 移除 `setMarked()` 方法;
- 新增 HTML 标签解析过滤机制;
- 通过设置 `settings.htmlDecode = "style,script,iframe"` 来实现过滤指定标签的解析;
- 改进 Require.js 支持;
- 修复 Require.js 下 CodeMirror 编辑器的代码无法高亮的问题;
- 更新 `underscore` 版本至 `1.8.2`
- 移除 `editormd.requirejsInit()``editormd.requireModules()` 方法;
- 新增 `Require.js/AMD` 专用版本文件 `editormd.amd.js`
- 新建 Gulp 任务 `amd`
- 修改和新增以上改进等相关示例;
### v1.3
#### v1.3.0
主要更新:
- 预设键盘快捷键处理(粗体等),插入 Markdown 更加方便;
- 更新 CodeMirror 版本为 `5.0`
- 更新 Marked 版本为 `0.3.3`
- 新增自动高度和工具栏固定定位功能;
- 改进表格插入对话框;
- 工具栏新增三个按钮,分别是将所选文本首字母转成大写、转成小写、转成大写;
- 修改使用帮助文档;
- 修复多个 Bug
具体更新如下:
- 新增常用键盘快捷键预设处理;
- 新增属性 `editormd.keyMaps` ,预设一些常用操作,例如插入粗体等;
- 新增成员方法 `registerKeyMaps()`
- 退出HTML全屏预览快捷键更改为 `Shift + ESC`
- 新增配置项 `disabledKeyMaps` ,用于屏蔽一些快捷键操作;
- 更新 CodeMirror 版本为 `5.0`
- 修改无法输入 `/` 的问题;
- 更新 Marked 版本为 `0.3.3`
- 新增自动高度和工具栏固定定位(滚动条拖动时)模式;
- 新增配置项 `settings.autoHeight`
- 新增配置项 `settings.toolbarAutoFixed`
- 新增方法 `setToolbarAutoFixed(true|false)`
- 新增邮箱地址自动添加链接功能;
- 新增配置项 `emailLink` ,默认为 `true` ;
- 改进表格插入对话框;
- 工具栏新增三个按钮,分别是将所选文本首字母转成大写、转成小写、转成大写;
- 新增方法 `editormd.ucwords()` ,别名 `editormd.wordsFirstUpperCase()`
- 新增方法 `editormd.ucfirst()` ,别名 `editormd.firstUpperCase()`
- 新增两个成员方法 `getSelections()``getSelections()`
- 修复 Font awesome 图标 emoji 部分无法解析的 Bug,[#39](https://github.com/pandao/editor.md/issues/39)
- 改进 @link 功能 [#40](https://github.com/pandao/editor.md/issues/40)
- 新增配置项 `atLink` ,默认为 `true` ;
- 修复无法输入 `/` 的问题 [#42](https://github.com/pandao/editor.md/issues/42)
- 修改使用帮助说明的错误 [#43](https://github.com/pandao/editor.md/issues/43)
- 新增配置项 `pluginPath`,默认为空时,等于 `settings.path + "../plugins/"`
### v1.4
#### v1.4.0
主要更新:
- 新增延迟解析机制,预览更即时;
- 新增跳转到指定行的功能和对话框;
- 新增 ToC 下拉菜单、自定义 ToC 容器的功能;
- 新增跳转到行、搜索的工具栏按钮;
- 新增支持插入和解析(打印)分页符;
- 改进快捷键功能和自动高度模式等;
- 改进:将锚点链接改名为引用链接;
- 改进编辑器重建和重配置功能;
- 修复多个 Bug
具体更新:
- 新增延迟解析预览的机制,解决输入太多太快出现的 “延迟卡顿” 问题;
- 新增配置项 `delay` ,默认值为 `300`
- 修复当输入速度太快时,解析Flowchart会抛出错误的问题;
- 修改 iPad 等移动终端的浏览器无法上传图片的问题 [#48](https://github.com/pandao/editor.md/issues/48)
- 修复单独引用 `editormd.preview.css` 时无法显示 Font Awesome 和 Editor.md logo 字体的问题;
- 更新和修改 Gulp 构建;
- 修改了 `Gulpfile.js` ,并且 `gulp-ruby-sass` 升级到最新版本 `1.0.0-alpha.3` ;
- 编辑 SCSS 时,不再生成 CSS 的 Source map 文件;
- 执行 jshint 和更正一些 JS 写法的不规范,精简了代码;
- 新增配置项 `appendMarkdown``appendMarkdown()` 方法,用于(初始化前后)追加 Markdown 到 Textarea
- 改进部分预设快捷键功能,包括 F9 (watch)、F10 (preview)、F11 (fullscreen)等;
- 修复自动高度模式下出现的几个问题;
- 全屏退出时高度不正确的问题:修改了 `fullscreenExit()` 方法的内部实现;
- 当解析预览后的 HTML 内容高度高于 Markdown 源码编辑器高度时,无法正确预览的问题 [#49](https://github.com/pandao/editor.md/issues/49)
- 修改 `onscroll``onpreviewscroll` 无法访问 `this` 的问题;
- 修改 `init()` 方法,可以只设置一个参数;
- 新增插入 TeX (KaTeX) 公式的快捷键 `Ctrl + Shift + K` 和插入方法 `tex()`
- 将锚点链接改为引用链接,引用的链接改为插入到页尾;
- 工具栏的名称 `anchor` 改为 `reference-link`
- 工具栏的名称 `htmlEntities` 改名为 `html-entities`
- 改进编辑器重建和重配置功能;
- 修改了 `loadedDisplay()` 方法;
- 修改了 `config()``recreate()` 方法;
- 新增跳转到指定行的功能;
- 新增方法 `gotoLine()`
- 新增跳转到行对话框插件 `goto-line-dialog`
- 新增快捷键 `Ctrl + Alt + G`
- 改进 `executePlugin()` 方法;
- 修改了 `help-dialog/help.md`
- 新增搜索工具栏按钮;
- 新增方法 `search()``searchReplace()``searchReplaceAll()`
- 原全屏预览 HTML 按钮的图标改为 `fa-desktop`
- 改为默认开启搜索替换功能;
- 更换了关于 Editor.md 的标语( slogan );
- 标题按钮 `h` 改为大写的 `H`
- `saveToTextareas()` 方法更名为 `save()`
- 新增 ToC 下拉菜单、自定义 ToC 容器的功能;
- 新增 Markdown 扩展语法 `[TOCM]` ,自动生成 ToC 下拉菜单;
- 新增配置项 `tocm` ,默认为 `true`,即可以使用 `[TOCM]`
- 新增配置项 `tocDropdown``tocTitle`
- 新增方法 `editormd.tocDropdownMenu()`
- 新增配置项 `tocContainer` ,值为 jQuery 选择器,默认为空;
- 修改了配置项 `placeholder` 的默认值;
- 改进对 IE8 的兼容支持;
- 修复 Firefox 下因为 `Object.watch()` 而出现的问题;
- 新增支持插入和解析(打印)分页符;
- 新增配置项 `pageBreak` ,默认值为 `true`
- 新增语法 `[========]` ,即括号内至少 8 个等号;
- 新增插入分页符的工具栏图标和方法 `pagebreak()`
- 新增插入分页符的快捷键 `Shift + Alt + P`
- 修复一些 Bug,包括 [#51](https://github.com/pandao/editor.md/issues/51) 等;
- 新增和修改以上更新的相关示例;
#### v1.4.1
- 新增配置项 `syncScrolling`,即是否开启同步滚动预览,默认值为 `false`
- 修复 Bug [64](https://github.com/pandao/editor.md/issues/64)
- 更新 `editormd.katexURL` 资源地址的默认值,即更新版本为 `0.3.0`
- 新增测试用例`tests/katex-tests.html`
- 修改示例文件`examples/katex.html`
- 修复 Bug [66](https://github.com/pandao/editor.md/issues/66)
- 修复编辑器工具栏按钮 `:hover` CSS3 transition 无效的问题;
- 修改了 `README.md`
#### v1.4.2
- 改进和增强自定义工具栏功能,支持图标按钮右对齐 [#69](https://github.com/pandao/editor.md/issues/69)
- 改进和增强 HTML 标签的解析过滤功能,支持过滤指定的属性等 [#70](https://github.com/pandao/editor.md/issues/70)
- 删除分支 `mathjax-version``v1.1.9`
#### v1.4.3
- 改进:可配置是否自动聚焦编辑器 [#74](https://github.com/pandao/editor.md/issues/74)
- 新增配置项 `autoFocus`,默认值为 `true`;
- 修复 Bug [#77](https://github.com/pandao/editor.md/issues/77)
- 改进:帮助对话框里的链接改为新窗口打开,避免直接跳转到链接,导致编辑内容丢失的问题 [#79](https://github.com/pandao/editor.md/issues/79)
- 改进和完善编辑器配置项;
- 新增配置项 `tabSize``indentUnit``lineWrapping`
- 新增配置项 `autoCloseBrackets``showTrailingSpace`
- 新增配置项 `matchBrackets``indentWithTabs``styleSelectedText`
- 改进:修改 CSS `font-family`,改进跨平台中英文字体显示;
- 修改了 `README.md`
#### v1.4.4
- 修复 Bug [#81](https://github.com/pandao/editor.md/issues/81),即不支持 `:+1:` 的问题;
- 修复 Bug [#85](https://github.com/pandao/editor.md/issues/85),即图片上传返回结果不支持 `Content-Type=application/json` 的问题;
- 修复图片上传无法显示 loading 的问题;
#### v1.4.5
- 规范项目的中英文混排;
- 新增配置项 `name`,用于指定 Markdown textarea 的 `name="xxxx"` 属性;
- 修复 Bug,即无法正确解析公式的 `<``>` 的问题 [#87](https://github.com/pandao/editor.md/issues/87);
- 修复 Bug,即 `getHTML()` 无效的问题 [#95](https://github.com/pandao/editor.md/issues/95);
- 修复 Bug,即火狐上传图片后无法返回值的问题 [#96](https://github.com/pandao/editor.md/issues/96);
- 修改了图片上传插件;
- 修改 PHP 上传类及示例;
- 方法更名:`extends()` 更名为 `extend()`,以兼容 IE8
- 修复 IE8 下 Emoji 正则表达式字符集越界的问题;
- 更新了 `README.md``CHANGE.md` 等相关文档文件;
### v1.5
#### v1.5.0
主要更新:
- 新增:编辑器黑色主题 Dark,改进自定义主题功能(即工具栏、编辑区、预览区可分别设置主题样式);
- 新增:多行公式支持;
- 新增:支持非编辑状态下的 ToC 自定义容器;
- 新增:支持设置为单向同步滚动;
- 改进:编辑器样式美化,更换了滚动条样式;
- 改进:提高同步滚动定位的精确度;
- 改进:修复和改进 HTML 标签及属性过滤功能;
- 改进:修复在 Bootstrap 下的兼容性问题;
- 修复多处 Bug
具体更新:
- 新增:解析后的代码块自动换行;
- 新增:支持多行公式;
- 新增:新增语法:\`\`\`math | latex | katex
- 改进:美化 KaTeX 公式,即加大字号等;
- 新增:支持设置为单向同步滚动,即只是编辑区单向同步滚动,配置项 `syncScrolling : "single"`
- 新增:配置同步滚动示例文件 `sync-scrolling.html`
- 新增:增加了编辑器样式主题 Dark,即工具栏和预览区各自有一个暗黑色主题;
- 变更:自 `v1.5.0` 开始,配置项 `theme` 改为指定 Editor.md 本身的主题;
- 新增配置项 `editorTheme` ,用于指定编辑区的主题,即 CodeMirror 的主题;
- 新增配置项 `previewTheme` ,用于指定预览区的主题;
- 新增方法 `setEditorTheme()`,别名: `setCodeMirror()`
- 新增方法 `setPreviewTheme()`
- 修改了方法 `setTheme()`
- 更换了滚动条样式,Only Webkit
- 改进全屏状态下的样式显示,去掉 JS 操作的部分,改为通过 CSS 样式类 `.editormd-fullscreen` 控制;
- 修改和增加相关的方法、SCSS 文件及示例文件 `themes.html`
- 新增:非编辑状态下 ToC 自定义容器支持;
- 新增配置项 `markdownSourceCode`,即解析后是否保留源码,默认为不保留 `false`
- 新增配置项 `tocContainer`,值为自定义 ToC 容器的 ID 选择器 `#xxxxx`,默认为空;
- 新增和修改了相关示例文件;
- 新增:新增加了 CSS 样式类 `editormd-preview-active`,可以控制全屏HTML预览时的内容层样式;
- 修改了 `previewing()``previewed()` 方法;
- 相关 issues [#103](https://github.com/pandao/editor.md/issues/103)
- 另外也调整了关闭按钮的位置;
- 改进:修复插入 Emoji `:moon:` 无法显示的问题,修改为其是 `:waxing_gibbous_moon:` 的别名 [#94](https://github.com/pandao/editor.md/pull/94)
- 改进:修改了 CodeMirror 代码行的左右内间距,使其不会挨着左边的行号层;
- 相关 issues [#97](https://github.com/pandao/editor.md/issues/97)
- 改进:修改了同步滚动的定位算法,提高精确度;
- 修正问题 [#99](https://github.com/pandao/editor.md/issues/99)
- 修改了 `bindScrollEvent()` 方法;
- 改进:完善 HTML 标签过滤功能,即代码块、`<pre>` 预格式文本和行内代码里的标签及属性不会被过滤;
- 修复 Bug [#105](https://github.com/pandao/editor.md/issues/105)
- 改进:当不显示行号时 `settings.lineNumbers == false`CodeMirror 行号层去掉右边框;
- 改进:根据指针在当前行的位置更合理插入标题和水平线 [#104](https://github.com/pandao/editor.md/pull/104)
- 改进:调整了字体,优先显示 `"YaHei Consolas Hybrid", Consolas`
- 改进:修复在 Bootstrap 下的兼容性问题,即因为 box-sizing 写错位置导致的弹出层宽度等错位问题 [#107](https://github.com/pandao/editor.md/issues/107)
@@ -0,0 +1,358 @@
"use strict";
var os = require("os");
var gulp = require("gulp");
var gutil = require("gulp-util");
var sass = require("gulp-ruby-sass");
var jshint = require("gulp-jshint");
var uglify = require("gulp-uglifyjs");
var rename = require("gulp-rename");
var concat = require("gulp-concat");
var notify = require("gulp-notify");
var header = require("gulp-header");
var minifycss = require("gulp-minify-css");
//var jsdoc = require("gulp-jsdoc");
//var jsdoc2md = require("gulp-jsdoc-to-markdown");
var pkg = require("./package.json");
var dateFormat = require("dateformatter").format;
var replace = require("gulp-replace");
pkg.name = "Editor.md";
pkg.today = dateFormat;
var headerComment = ["/*",
" * <%= pkg.name %>",
" *",
" * @file <%= fileName(file) %> ",
" * @version v<%= pkg.version %> ",
" * @description <%= pkg.description %>",
" * @license MIT License",
" * @author <%= pkg.author %>",
" * {@link <%= pkg.homepage %>}",
" * @updateTime <%= pkg.today('Y-m-d') %>",
" */",
"\r\n"].join("\r\n");
var headerMiniComment = "/*! <%= pkg.name %> v<%= pkg.version %> | <%= fileName(file) %> | <%= pkg.description %> | MIT License | By: <%= pkg.author %> | <%= pkg.homepage %> | <%=pkg.today('Y-m-d') %> */\r\n";
var scssTask = function (fileName, path) {
path = path || "scss/";
var distPath = "css";
return sass(path + fileName + ".scss", {style: "expanded", sourcemap: false, noCache: true})
.pipe(gulp.dest(distPath))
.pipe(header(headerComment, {
pkg: pkg, fileName: function (file) {
var name = file.path.split(file.base);
return name[1].replace("\\", "");
}
}))
.pipe(gulp.dest(distPath))
.pipe(rename({suffix: ".min"}))
.pipe(gulp.dest(distPath))
.pipe(minifycss())
.pipe(gulp.dest(distPath))
.pipe(header(headerMiniComment, {
pkg: pkg, fileName: function (file) {
var name = file.path.split(file.base);
return name[1].replace("\\", "");
}
}))
.pipe(gulp.dest(distPath))
.pipe(notify({message: fileName + ".scss task completed!"}));
};
gulp.task("scss", function () {
return scssTask("editormd");
});
gulp.task("scss2", function () {
return scssTask("editormd.preview");
});
gulp.task("scss3", function () {
return scssTask("editormd.logo");
});
gulp.task("js", function () {
return gulp.src("./src/editormd.js")
.pipe(jshint("./.jshintrc"))
.pipe(jshint.reporter("default"))
.pipe(header(headerComment, {
pkg: pkg, fileName: function (file) {
var name = file.path.split(file.base);
return name[1].replace(/[\\\/]?/, "");
}
}))
.pipe(gulp.dest("./"))
.pipe(rename({suffix: ".min"}))
.pipe(uglify()) // {outSourceMap: true, sourceRoot: './'}
.pipe(gulp.dest("./"))
.pipe(header(headerMiniComment, {
pkg: pkg, fileName: function (file) {
var name = file.path.split(file.base + ((os.platform() === "win32") ? "\\" : "/"));
return name[1].replace(/[\\\/]?/, "");
}
}))
.pipe(gulp.dest("./"))
.pipe(notify({message: "editormd.js task complete"}));
});
gulp.task("amd", function () {
var replaceText1 = [
'var cmModePath = "codemirror/mode/";',
' var cmAddonPath = "codemirror/addon/";',
'',
' var codeMirrorModules = [',
' "jquery", "marked", "prettify",',
' "katex", "raphael", "underscore", "flowchart", "jqueryflowchart", "sequenceDiagram",',
'',
' "codemirror/lib/codemirror",',
' cmModePath + "css/css",',
' cmModePath + "sass/sass",',
' cmModePath + "shell/shell",',
' cmModePath + "sql/sql",',
' cmModePath + "clike/clike",',
' cmModePath + "php/php",',
' cmModePath + "xml/xml",',
' cmModePath + "markdown/markdown",',
' cmModePath + "javascript/javascript",',
' cmModePath + "htmlmixed/htmlmixed",',
' cmModePath + "gfm/gfm",',
' cmModePath + "http/http",',
' cmModePath + "go/go",',
' cmModePath + "dart/dart",',
' cmModePath + "coffeescript/coffeescript",',
' cmModePath + "nginx/nginx",',
' cmModePath + "python/python",',
' cmModePath + "perl/perl",',
' cmModePath + "lua/lua",',
' cmModePath + "r/r", ',
' cmModePath + "ruby/ruby", ',
' cmModePath + "rst/rst",',
' cmModePath + "smartymixed/smartymixed",',
' cmModePath + "vb/vb",',
' cmModePath + "vbscript/vbscript",',
' cmModePath + "velocity/velocity",',
' cmModePath + "xquery/xquery",',
' cmModePath + "yaml/yaml",',
' cmModePath + "erlang/erlang",',
' cmModePath + "jade/jade",',
'',
' cmAddonPath + "edit/trailingspace", ',
' cmAddonPath + "dialog/dialog", ',
' cmAddonPath + "search/searchcursor", ',
' cmAddonPath + "search/search", ',
' cmAddonPath + "scroll/annotatescrollbar", ',
' cmAddonPath + "search/matchesonscrollbar", ',
' cmAddonPath + "display/placeholder", ',
' cmAddonPath + "edit/closetag", ',
' cmAddonPath + "fold/foldcode",',
' cmAddonPath + "fold/foldgutter",',
' cmAddonPath + "fold/indent-fold",',
' cmAddonPath + "fold/brace-fold",',
' cmAddonPath + "fold/xml-fold", ',
' cmAddonPath + "fold/markdown-fold",',
' cmAddonPath + "fold/comment-fold", ',
' cmAddonPath + "mode/overlay", ',
' cmAddonPath + "selection/active-line", ',
' cmAddonPath + "edit/closebrackets", ',
' cmAddonPath + "display/fullscreen",',
' cmAddonPath + "search/match-highlighter"',
' ];',
'',
' define(codeMirrorModules, factory);'
].join("\r\n");
var replaceText2 = [
"if (typeof define == \"function\" && define.amd) {",
" $ = arguments[0];",
" marked = arguments[1];",
" prettify = arguments[2];",
" katex = arguments[3];",
" Raphael = arguments[4];",
" _ = arguments[5];",
" flowchart = arguments[6];",
" CodeMirror = arguments[9];",
" }"
].join("\r\n");
gulp.src("src/editormd.js")
.pipe(rename({suffix: ".amd"}))
.pipe(gulp.dest('./'))
.pipe(header(headerComment, {
pkg: pkg, fileName: function (file) {
var name = file.path.split(file.base);
return name[1].replace(/[\\\/]?/, "");
}
}))
.pipe(gulp.dest("./"))
.pipe(replace("/* Require.js define replace */", replaceText1))
.pipe(gulp.dest('./'))
.pipe(replace("/* Require.js assignment replace */", replaceText2))
.pipe(gulp.dest('./'))
.pipe(rename({suffix: ".min"}))
.pipe(uglify()) //{outSourceMap: true, sourceRoot: './'}
.pipe(gulp.dest("./"))
.pipe(header(headerMiniComment, {
pkg: pkg, fileName: function (file) {
var name = file.path.split(file.base + ((os.platform() === "win32") ? "\\" : "/"));
return name[1].replace(/[\\\/]?/, "");
}
}))
.pipe(gulp.dest("./"))
.pipe(notify({message: "amd version task complete"}));
});
var codeMirror = {
path: {
src: {
mode: "lib/codemirror/mode",
addon: "lib/codemirror/addon"
},
dist: "lib/codemirror"
},
modes: [
"css",
"sass",
"shell",
"sql",
"clike",
"php",
"xml",
"markdown",
"javascript",
"htmlmixed",
"gfm",
"http",
"go",
"dart",
"coffeescript",
"nginx",
"python",
"perl",
"lua",
"r",
"ruby",
"rst",
"smartymixed",
"vb",
"vbscript",
"velocity",
"xquery",
"yaml",
"erlang",
"jade",
],
addons: [
"edit/trailingspace",
"dialog/dialog",
"search/searchcursor",
"search/search",
"scroll/annotatescrollbar",
"search/matchesonscrollbar",
"display/placeholder",
"edit/closetag",
"fold/foldcode",
"fold/foldgutter",
"fold/indent-fold",
"fold/brace-fold",
"fold/xml-fold",
"fold/markdown-fold",
"fold/comment-fold",
"mode/overlay",
"selection/active-line",
"edit/closebrackets",
"display/fullscreen",
"search/match-highlighter"
]
};
gulp.task("cm-mode", function () {
var modes = [
codeMirror.path.src.mode + "/meta.js"
];
for (var i in codeMirror.modes) {
var mode = codeMirror.modes[i];
modes.push(codeMirror.path.src.mode + "/" + mode + "/" + mode + ".js");
}
return gulp.src(modes)
.pipe(concat("modes.min.js"))
.pipe(gulp.dest(codeMirror.path.dist))
.pipe(uglify()) // {outSourceMap: true, sourceRoot: codeMirror.path.dist}
.pipe(gulp.dest(codeMirror.path.dist))
.pipe(header(headerMiniComment, {
pkg: pkg, fileName: function (file) {
var name = file.path.split(file.base + "\\");
return (name[1] ? name[1] : name[0]).replace(/\\/g, "");
}
}))
.pipe(gulp.dest(codeMirror.path.dist))
.pipe(notify({message: "codemirror-mode task complete!"}));
});
gulp.task("cm-addon", function () {
var addons = [];
for (var i in codeMirror.addons) {
var addon = codeMirror.addons[i];
addons.push(codeMirror.path.src.addon + "/" + addon + ".js");
}
return gulp.src(addons)
.pipe(concat("addons.min.js"))
.pipe(gulp.dest(codeMirror.path.dist))
.pipe(uglify()) //{outSourceMap: true, sourceRoot: codeMirror.path.dist}
.pipe(gulp.dest(codeMirror.path.dist))
.pipe(header(headerMiniComment, {
pkg: pkg, fileName: function (file) {
var name = file.path.split(file.base + "\\");
return (name[1] ? name[1] : name[0]).replace(/\\/g, "");
}
}))
.pipe(gulp.dest(codeMirror.path.dist))
.pipe(notify({message: "codemirror-addon.js task complete"}));
});
/*
gulp.task("jsdoc", function(){
return gulp.src(["./src/editormd.js", "README.md"])
.pipe(jsdoc.parser())
.pipe(jsdoc.generator("./docs/html"));
});
gulp.task("jsdoc2md", function() {
return gulp.src("src/js/editormd.js")
.pipe(jsdoc2md())
.on("error", function(err){
gutil.log(gutil.colors.red("jsdoc2md failed"), err.message);
})
.pipe(rename(function(path) {
path.extname = ".md";
}))
.pipe(gulp.dest("docs/markdown"));
});
*/
gulp.task("watch", function () {
gulp.watch("scss/editormd.scss", ["scss"]);
gulp.watch("scss/editormd.preview.scss", ["scss", "scss2"]);
gulp.watch("scss/editormd.logo.scss", ["scss", "scss3"]);
gulp.watch("src/editormd.js", ["js", "amd"]);
});
gulp.task("default", function () {
gulp.run("scss");
gulp.run("scss2");
gulp.run("scss3");
gulp.run("js");
gulp.run("amd");
gulp.run("cm-addon");
gulp.run("cm-mode");
});
@@ -0,0 +1,22 @@
The MIT License (MIT)
Copyright (c) 2015 pandao
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,268 @@
# Editor.md
![](https://pandao.github.io/editor.md/images/logos/editormd-logo-180x180.png)
![](https://img.shields.io/github/stars/pandao/editor.md.svg)
![](https://img.shields.io/github/forks/pandao/editor.md.svg)
![](https://img.shields.io/github/tag/pandao/editor.md.svg)
![](https://img.shields.io/github/release/pandao/editor.md.svg)
![](https://img.shields.io/github/issues/pandao/editor.md.svg)
![](https://img.shields.io/bower/v/editor.md.svg)
**Editor.md** : The open source embeddable online markdown editor (component), based on CodeMirror & jQuery & Marked.
### Features
- Support Standard Markdown / CommonMark and GFM (GitHub Flavored Markdown);
- Full-featured: Real-time Preview, Image (cross-domain) upload, Preformatted text/Code blocks/Tables insert, Code fold, Search replace, Read only, Themes, Multi-languages, L18n, HTML entities, Code syntax highlighting...;
- Markdown Extras : Support [ToC (Table of Contents)](https://pandao.github.io/editor.md/examples/toc.html), [Emoji](https://pandao.github.io/editor.md/examples/emoji.html), [Task lists](https://pandao.github.io/editor.md/examples/task-lists.html), [@Links](https://pandao.github.io/editor.md/examples/@links.html)...;
- Compatible with all major browsers (IE8+), compatible Zepto.js and iPad;
- Support [decode & fliter of the HTML tags & attributes](https://pandao.github.io/editor.md/examples/html-tags-decode.html);
- Support [TeX (LaTeX expressions, Based on KaTeX)](https://pandao.github.io/editor.md/examples/katex.html), [Flowchart](https://pandao.github.io/editor.md/examples/flowchart.html) and [Sequence Diagram](https://pandao.github.io/editor.md/examples/sequence-diagram.html) of Markdown extended syntax;
- Support AMD/CMD (Require.js & Sea.js) Module Loader, and Custom/define editor plugins;
[README & Examples (English)](https://pandao.github.io/editor.md/en.html)
--------
**Editor.md** 是一款开源的、可嵌入的 Markdown 在线编辑器(组件),基于 CodeMirror、jQuery 和 Marked 构建。
![editormd-screenshot](https://pandao.github.io/editor.md/examples/images/editormd-screenshot.png "editormd-screenshot")
#### 主要特性
- 支持通用 Markdown / CommonMark 和 GFM (GitHub Flavored Markdown) 风格的语法,也可[变身为代码编辑器](https://pandao.github.io/editor.md/examples/change-mode.html)
- 支持实时预览、图片(跨域)上传、预格式文本/代码/表格插入、代码折叠、跳转到行、搜索替换、只读模式、自定义样式主题和多语言语法高亮等功能;
- 支持 [ToCTable of Contents](https://pandao.github.io/editor.md/examples/toc.html)、[Emoji表情](https://pandao.github.io/editor.md/examples/emoji.html)、[Task lists](https://pandao.github.io/editor.md/examples/task-lists.html)、[@链接](https://pandao.github.io/editor.md/examples/@links.html)等 Markdown 扩展语法;
- 支持 TeX 科学公式(基于 [KaTeX](https://pandao.github.io/editor.md/examples/katex.html))、流程图 [Flowchart](https://pandao.github.io/editor.md/examples/flowchart.html) 和 [时序图 Sequence Diagram](https://pandao.github.io/editor.md/examples/sequence-diagram.html);
- 支持[识别和解析 HTML 标签,并且支持自定义过滤标签及属性解析](https://pandao.github.io/editor.md/examples/html-tags-decode.html),具有可靠的安全性和几乎无限的扩展性;
- 支持 AMD / CMD 模块化加载(支持 [Require.js](https://pandao.github.io/editor.md/examples/use-requirejs.html) & [Sea.js](https://pandao.github.io/editor.md/examples/use-seajs.html)),并且支持[自定义扩展插件](https://pandao.github.io/editor.md/examples/define-plugin.html)
- 兼容主流的浏览器(IE8+)和 [Zepto.js](https://pandao.github.io/editor.md/examples/use-zepto.html),且支持 iPad 等平板设备;
#### Download & install
Download:
[Github download](https://github.com/pandao/editor.md/archive/master.zip)
NPM install :
```bash
npm install editor.md
```
Bower install :
```bash
bower install editor.md
```
#### Usages
##### Create a Markdown editor
```html
<link rel="stylesheet" href="editor.md/css/editormd.min.css" />
<div id="editor">
<!-- Tips: Editor.md can auto append a `<textarea>` tag -->
<textarea style="display:none;">### Hello Editor.md !</textarea>
</div>
<script src="jquery.min.js"></script>
<script src="editor.md/editormd.min.js"></script>
<script type="text/javascript">
$(function() {
var editor = editormd("editor", {
// width: "100%",
// height: "100%",
// markdown: "xxxx", // dynamic set Markdown text
path : "editor.md/lib/" // Autoload modules mode, codemirror, marked... dependents libs path
});
});
</script>
```
If you using modular script loader:
- [Using Require.js](https://github.com/pandao/editor.md/tree/master/examples/use-requirejs.html)
- [Using Sea.js](https://github.com/pandao/editor.md/tree/master/examples/use-seajs.html)
##### Markdown to HTML
```html
<link rel="stylesheet" href="editormd/css/editormd.preview.css" />
<div id="test-markdown-view">
<!-- Server-side output Markdown text -->
<textarea style="display:none;">### Hello world!</textarea>
</div>
<script src="jquery.min.js"></script>
<script src="editormd/editormd.js"></script>
<script src="editormd/lib/marked.min.js"></script>
<script src="editormd/lib/prettify.min.js"></script>
<script type="text/javascript">
$(function() {
var testView = editormd.markdownToHTML("test-markdown-view", {
// markdown : "[TOC]\n### Hello world!\n## Heading 2", // Also, you can dynamic set Markdown text
// htmlDecode : true, // Enable / disable HTML tag encode.
// htmlDecode : "style,script,iframe", // Note: If enabled, you should filter some dangerous HTML tags for website security.
});
});
</script>
```
> See the full example: [http://editor.md.ipandao.com/examples/html-preview-markdown-to-html.html](http://editor.md.ipandao.com/examples/html-preview-markdown-to-html.html)
##### HTML to Markdown?
Sorry, Editor.md not support HTML to Markdown parsing, Maybe In the future.
#### Examples
[https://pandao.github.io/editor.md/examples/index.html](https://pandao.github.io/editor.md/examples/index.html)
#### Options
Editor.md options and default values:
```javascript
{
mode : "gfm", // gfm or markdown
name : "", // Form element name for post
value : "", // value for CodeMirror, if mode not gfm/markdown
theme : "", // Editor.md self themes, before v1.5.0 is CodeMirror theme, default empty
editorTheme : "default", // Editor area, this is CodeMirror theme at v1.5.0
previewTheme : "", // Preview area theme, default empty
markdown : "", // Markdown source code
appendMarkdown : "", // if in init textarea value not empty, append markdown to textarea
width : "100%",
height : "100%",
path : "./lib/", // Dependents module file directory
pluginPath : "", // If this empty, default use settings.path + "../plugins/"
delay : 300, // Delay parse markdown to html, Uint : ms
autoLoadModules : true, // Automatic load dependent module files
watch : true,
placeholder : "Enjoy Markdown! coding now...",
gotoLine : true, // Enable / disable goto a line
codeFold : false,
autoHeight : false,
autoFocus : true, // Enable / disable auto focus editor left input area
autoCloseTags : true,
searchReplace : true, // Enable / disable (CodeMirror) search and replace function
syncScrolling : true, // options: true | false | "single", default true
readOnly : false, // Enable / disable readonly mode
tabSize : 4,
indentUnit : 4,
lineNumbers : true, // Display editor line numbers
lineWrapping : true,
autoCloseBrackets : true,
showTrailingSpace : true,
matchBrackets : true,
indentWithTabs : true,
styleSelectedText : true,
matchWordHighlight : true, // options: true, false, "onselected"
styleActiveLine : true, // Highlight the current line
dialogLockScreen : true,
dialogShowMask : true,
dialogDraggable : true,
dialogMaskBgColor : "#fff",
dialogMaskOpacity : 0.1,
fontSize : "13px",
saveHTMLToTextarea : false, // If enable, Editor will create a <textarea name="{editor-id}-html-code"> tag save HTML code for form post to server-side.
disabledKeyMaps : [],
onload : function() {},
onresize : function() {},
onchange : function() {},
onwatch : null,
onunwatch : null,
onpreviewing : function() {},
onpreviewed : function() {},
onfullscreen : function() {},
onfullscreenExit : function() {},
onscroll : function() {},
onpreviewscroll : function() {},
imageUpload : false, // Enable/disable upload
imageFormats : ["jpg", "jpeg", "gif", "png", "bmp", "webp"],
imageUploadURL : "", // Upload url
crossDomainUpload : false, // Enable/disable Cross-domain upload
uploadCallbackURL : "", // Cross-domain upload callback url
toc : true, // Table of contents
tocm : false, // Using [TOCM], auto create ToC dropdown menu
tocTitle : "", // for ToC dropdown menu button
tocDropdown : false, // Enable/disable Table Of Contents dropdown menu
tocContainer : "", // Custom Table Of Contents Container Selector
tocStartLevel : 1, // Said from H1 to create ToC
htmlDecode : false, // Open the HTML tag identification
pageBreak : true, // Enable parse page break [========]
atLink : true, // for @link
emailLink : true, // for email address auto link
taskList : false, // Enable Github Flavored Markdown task lists
emoji : false, // :emoji: , Support Github emoji, Twitter Emoji (Twemoji);
// Support FontAwesome icon emoji :fa-xxx: > Using fontAwesome icon web fonts;
// Support Editor.md logo icon emoji :editormd-logo: :editormd-logo-1x: > 1~8x;
tex : false, // TeX(LaTeX), based on KaTeX
flowChart : false, // flowChart.js only support IE9+
sequenceDiagram : false, // sequenceDiagram.js only support IE9+
previewCodeHighlight : true, // Enable / disable code highlight of editor preview area
toolbar : true, // show or hide toolbar
toolbarAutoFixed : true, // on window scroll auto fixed position
toolbarIcons : "full", // Toolbar icons mode, options: full, simple, mini, See `editormd.toolbarModes` property.
toolbarTitles : {},
toolbarHandlers : {
ucwords : function() {
return editormd.toolbarHandlers.ucwords;
},
lowercase : function() {
return editormd.toolbarHandlers.lowercase;
}
},
toolbarCustomIcons : { // using html tag create toolbar icon, unused default <a> tag.
lowercase : "<a href=\"javascript:;\" title=\"Lowercase\" unselectable=\"on\"><i class=\"fa\" name=\"lowercase\" style=\"font-size:24px;margin-top: -10px;\">a</i></a>",
"ucwords" : "<a href=\"javascript:;\" title=\"ucwords\" unselectable=\"on\"><i class=\"fa\" name=\"ucwords\" style=\"font-size:20px;margin-top: -3px;\">Aa</i></a>"
},
toolbarIconTexts : {},
lang : { // Language data, you can custom your language.
name : "zh-cn",
description : "开源在线Markdown编辑器<br/>Open source online Markdown editor.",
tocTitle : "目录",
toolbar : {
//...
},
button: {
//...
},
dialog : {
//...
}
//...
}
}
```
#### Dependents
- [CodeMirror](http://codemirror.net/ "CodeMirror")
- [marked](https://github.com/markedjs/marked "marked")
- [jQuery](http://jquery.com/ "jQuery")
- [FontAwesome](http://fontawesome.io/ "FontAwesome")
- [github-markdown.css](https://github.com/sindresorhus/github-markdown-css "github-markdown.css")
- [KaTeX](http://khan.github.io/KaTeX/ "KaTeX")
- [prettify.js](http://code.google.com/p/google-code-prettify/ "prettify.js")
- [Rephael.js](http://raphaeljs.com/ "Rephael.js")
- [flowchart.js](http://adrai.github.io/flowchart.js/ "flowchart.js")
- [sequence-diagram.js](http://bramp.github.io/js-sequence-diagrams/ "sequence-diagram.js")
- [Prefixes.scss](https://github.com/pandao/prefixes.scss "Prefixes.scss")
#### Changes
[Change logs](https://github.com/pandao/editor.md/blob/master/CHANGE.md)
#### License
The MIT License.
Copyright (c) 2015-2019 Pandao
@@ -0,0 +1,24 @@
{
"name": "editor.md",
"version": "1.5.0",
"homepage": "https://github.com/pandao/editor.md",
"authors": [
"Pandao <pandao@vip.qq.com>"
],
"description": "Open source online markdown editor.",
"keywords": [
"editor.md",
"markdown",
"editor"
],
"license": "MIT",
"ignore": [
"**/.*",
"research",
"docs",
"node_modules",
"bower_components",
"test",
"tests"
]
}
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,100 @@
/*
* Editor.md
*
* @file editormd.logo.css
* @version v1.5.0
* @description Open source online markdown editor.
* @license MIT License
* @author Pandao
* {@link https://github.com/pandao/editor.md}
* @updateTime 2015-06-09
*/
/*! prefixes.scss v0.1.0 | Author: Pandao | https://github.com/pandao/prefixes.scss | MIT license | Copyright (c) 2015 */
@font-face {
font-family: 'editormd-logo';
src: url("../fonts/editormd-logo.eot?-5y8q6h");
src: url(".../fonts/editormd-logo.eot?#iefix-5y8q6h") format("embedded-opentype"), url("../fonts/editormd-logo.woff?-5y8q6h") format("woff"), url("../fonts/editormd-logo.ttf?-5y8q6h") format("truetype"), url("../fonts/editormd-logo.svg?-5y8q6h#icomoon") format("svg");
font-weight: normal;
font-style: normal;
}
.editormd-logo,
.editormd-logo-1x,
.editormd-logo-2x,
.editormd-logo-3x,
.editormd-logo-4x,
.editormd-logo-5x,
.editormd-logo-6x,
.editormd-logo-7x,
.editormd-logo-8x {
font-family: 'editormd-logo';
speak: none;
font-style: normal;
font-weight: normal;
font-variant: normal;
text-transform: none;
font-size: inherit;
line-height: 1;
display: inline-block;
text-rendering: auto;
vertical-align: inherit;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
.editormd-logo:before,
.editormd-logo-1x:before,
.editormd-logo-2x:before,
.editormd-logo-3x:before,
.editormd-logo-4x:before,
.editormd-logo-5x:before,
.editormd-logo-6x:before,
.editormd-logo-7x:before,
.editormd-logo-8x:before {
content: "\e1987";
/*
HTML Entity &#xe1987;
example: <span class="editormd-logo">&#xe1987;</span>
*/
}
.editormd-logo-1x {
font-size: 1em;
}
.editormd-logo-lg {
font-size: 1.2em;
}
.editormd-logo-2x {
font-size: 2em;
}
.editormd-logo-3x {
font-size: 3em;
}
.editormd-logo-4x {
font-size: 4em;
}
.editormd-logo-5x {
font-size: 5em;
}
.editormd-logo-6x {
font-size: 6em;
}
.editormd-logo-7x {
font-size: 7em;
}
.editormd-logo-8x {
font-size: 8em;
}
.editormd-logo-color {
color: #2196F3;
}
@@ -0,0 +1,2 @@
/*! Editor.md v1.5.0 | editormd.logo.min.css | Open source online markdown editor. | MIT License | By: Pandao | https://github.com/pandao/editor.md | 2015-06-09 */
/*! prefixes.scss v0.1.0 | Author: Pandao | https://github.com/pandao/prefixes.scss | MIT license | Copyright (c) 2015 */@font-face{font-family:editormd-logo;src:url(../fonts/editormd-logo.eot?-5y8q6h);src:url(.../fonts/editormd-logo.eot?#iefix-5y8q6h)format("embedded-opentype"),url(../fonts/editormd-logo.woff?-5y8q6h)format("woff"),url(../fonts/editormd-logo.ttf?-5y8q6h)format("truetype"),url(../fonts/editormd-logo.svg?-5y8q6h#icomoon)format("svg");font-weight:400;font-style:normal}.editormd-logo,.editormd-logo-1x,.editormd-logo-2x,.editormd-logo-3x,.editormd-logo-4x,.editormd-logo-5x,.editormd-logo-6x,.editormd-logo-7x,.editormd-logo-8x{font-family:editormd-logo;speak:none;font-style:normal;font-weight:400;font-variant:normal;text-transform:none;font-size:inherit;line-height:1;display:inline-block;text-rendering:auto;vertical-align:inherit;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.editormd-logo-1x:before,.editormd-logo-2x:before,.editormd-logo-3x:before,.editormd-logo-4x:before,.editormd-logo-5x:before,.editormd-logo-6x:before,.editormd-logo-7x:before,.editormd-logo-8x:before,.editormd-logo:before{content:"\e1987"}.editormd-logo-1x{font-size:1em}.editormd-logo-lg{font-size:1.2em}.editormd-logo-2x{font-size:2em}.editormd-logo-3x{font-size:3em}.editormd-logo-4x{font-size:4em}.editormd-logo-5x{font-size:5em}.editormd-logo-6x{font-size:6em}.editormd-logo-7x{font-size:7em}.editormd-logo-8x{font-size:8em}.editormd-logo-color{color:#2196F3}
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 140 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 143 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 145 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 140 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 145 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 142 KiB

@@ -0,0 +1,42 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3></h3>
</div>
<nav>
<h2><a href="index.html">Home</a></h2>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0</a> on Mon Jun 08 2015 01:07:40
GMT+0800 (中国标准时间)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"></script>
</body>
</html>
@@ -0,0 +1,25 @@
/*global document */
(function () {
var source = document.getElementsByClassName('prettyprint source linenums');
var i = 0;
var lineNumber = 0;
var lineId;
var lines;
var totalLines;
var anchorHash;
if (source && source[0]) {
anchorHash = document.location.hash.substring(1);
lines = source[0].getElementsByTagName('li');
totalLines = lines.length;
for (; i < totalLines; i++) {
lineNumber++;
lineId = 'line' + lineNumber;
lines[i].id = lineId;
if (lineId === anchorHash) {
lines[i].className += ' selected';
}
}
}
})();
@@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
@@ -0,0 +1,2 @@
PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
@@ -0,0 +1,28 @@
var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c<i;++c){var j=f[c];if(/\\[bdsw]/i.test(j))a.push(j);else{var j=m(j),d;c+2<i&&"-"===f[c+1]?(d=m(f[c+2]),c+=2):d=j;b.push([j,d]);d<65||j>122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;c<b.length;++c)i=b[c],i[0]<=j[1]+1?j[1]=Math.max(j[1],i[1]):f.push(j=i);b=["["];o&&b.push("^");b.push.apply(b,a);for(c=0;c<
f.length;++c)i=f[c],b.push(e(i[0])),i[1]>i[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c<b;++c){var j=f[c];j==="("?++i:"\\"===j.charAt(0)&&(j=+j.substring(1))&&j<=i&&(d[j]=-1)}for(c=1;c<d.length;++c)-1===d[c]&&(d[c]=++t);for(i=c=0;c<b;++c)j=f[c],j==="("?(++i,d[i]===void 0&&(f[c]="(?:")):"\\"===j.charAt(0)&&
(j=+j.substring(1))&&j<=i&&(f[c]="\\"+d[i]);for(i=c=0;c<b;++c)"^"===f[c]&&"^"!==f[c+1]&&(f[c]="");if(a.ignoreCase&&s)for(c=0;c<b;++c)j=f[c],a=j.charAt(0),j.length>=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p<d;++p){var g=a[p];if(g.ignoreCase)l=!0;else if(/[a-z]/i.test(g.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi,""))){s=!0;l=!1;break}}for(var r=
{b:8,t:9,n:10,v:11,f:12,r:13},n=[],p=0,d=a.length;p<d;++p){g=a[p];if(g.global||g.multiline)throw Error(""+g);n.push("(?:"+y(g)+")")}return RegExp(n.join("|"),l?"gi":"g")}function M(a){function m(a){switch(a.nodeType){case 1:if(e.test(a.className))break;for(var g=a.firstChild;g;g=g.nextSibling)m(g);g=a.nodeName;if("BR"===g||"LI"===g)h[s]="\n",t[s<<1]=y++,t[s++<<1|1]=a;break;case 3:case 4:g=a.nodeValue,g.length&&(g=p?g.replace(/\r\n?/g,"\n"):g.replace(/[\t\n\r ]+/g," "),h[s]=g,t[s<<1]=y,y+=g.length,
t[s++<<1|1]=a)}}var e=/(?:^|\s)nocode(?:\s|$)/,h=[],y=0,t=[],s=0,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=document.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);m(a);return{a:h.join("").replace(/\n$/,""),c:t}}function B(a,m,e,h){m&&(a={a:m,d:a},e(a),h.push.apply(h,a.e))}function x(a,m){function e(a){for(var l=a.d,p=[l,"pln"],d=0,g=a.a.match(y)||[],r={},n=0,z=g.length;n<z;++n){var f=g[n],b=r[f],o=void 0,c;if(typeof b===
"string")c=!1;else{var i=h[f.charAt(0)];if(i)o=f.match(i[1]),b=i[0];else{for(c=0;c<t;++c)if(i=m[c],o=f.match(i[1])){b=i[0];break}o||(b="pln")}if((c=b.length>=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
l=[],p={},d=0,g=e.length;d<g;++d){var r=e[d],n=r[3];if(n)for(var k=n.length;--k>=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g<d.length;++g)e(d[g]);m===(m|0)&&d[0].setAttribute("value",
m);var r=s.createElement("OL");r.className="linenums";for(var n=Math.max(0,m-1|0)||0,g=0,z=d.length;g<z;++g)l=d[g],l.className="L"+(g+n)%10,l.firstChild||l.appendChild(s.createTextNode("\xa0")),r.appendChild(l);a.appendChild(r)}function k(a,m){for(var e=m.length;--e>=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*</.test(m)?"default-markup":"default-code";return A[a]}function E(a){var m=
a.g;try{var e=M(a.h),h=e.a;a.a=h;a.c=e.c;a.d=0;C(m,h)(a);var k=/\bMSIE\b/.test(navigator.userAgent),m=/\n/g,t=a.a,s=t.length,e=0,l=a.c,p=l.length,h=0,d=a.e,g=d.length,a=0;d[g]=s;var r,n;for(n=r=0;n<g;)d[n]!==d[n+2]?(d[r++]=d[n++],d[r++]=d[n++]):n+=2;g=r;for(n=r=0;n<g;){for(var z=d[n],f=d[n+1],b=n+2;b+2<=g&&d[b+1]===f;)b+=2;d[r++]=z;d[r++]=f;n=b}for(d.length=r;h<p;){var o=l[h+2]||s,c=d[a+2]||s,b=Math.min(o,c),i=l[h+1],j;if(i.nodeType!==1&&(j=t.substring(e,b))){k&&(j=j.replace(m,"\r"));i.nodeValue=
j;var u=i.ownerDocument,v=u.createElement("SPAN");v.className=d[a+1];var x=i.parentNode;x.replaceChild(v,i);v.appendChild(i);e<o&&(l[h+1]=i=u.createTextNode(t.substring(b,o)),x.insertBefore(i,v.nextSibling))}e=b;e>=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p<h.length&&l.now()<e;p++){var n=h[p],k=n.className;if(k.indexOf("prettyprint")>=0){var k=k.match(g),f,b;if(b=
!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p<h.length?setTimeout(m,
250):a&&a()}for(var e=[document.getElementsByTagName("pre"),document.getElementsByTagName("code"),document.getElementsByTagName("xmp")],h=[],k=0;k<e.length;++k)for(var t=0,s=e[k].length;t<s;++t)h.push(e[k][t]);var e=q,l=Date;l.now||(l={now:function(){return+new Date}});var p=0,d,g=/\blang(?:uage)?-([\w.]+)(?!\S)/;m()};window.PR={createSimpleLexer:x,registerLangHandler:k,sourceDecorator:u,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:"com",PR_DECLARATION:"dec",PR_KEYWORD:"kwd",PR_LITERAL:"lit",
PR_NOCODE:"nocode",PR_PLAIN:"pln",PR_PUNCTUATION:"pun",PR_SOURCE:"src",PR_STRING:"str",PR_TAG:"tag",PR_TYPE:"typ"}})();
@@ -0,0 +1,359 @@
@font-face {
font-family: 'Open Sans';
font-weight: normal;
font-style: normal;
src: url('../fonts/OpenSans-Regular-webfont.eot');
src: local('Open Sans'),
local('OpenSans'),
url('../fonts/OpenSans-Regular-webfont.eot?#iefix') format('embedded-opentype'),
url('../fonts/OpenSans-Regular-webfont.woff') format('woff'),
url('../fonts/OpenSans-Regular-webfont.svg#open_sansregular') format('svg');
}
@font-face {
font-family: 'Open Sans Light';
font-weight: normal;
font-style: normal;
src: url('../fonts/OpenSans-Light-webfont.eot');
src: local('Open Sans Light'),
local('OpenSans Light'),
url('../fonts/OpenSans-Light-webfont.eot?#iefix') format('embedded-opentype'),
url('../fonts/OpenSans-Light-webfont.woff') format('woff'),
url('../fonts/OpenSans-Light-webfont.svg#open_sanslight') format('svg');
}
html {
overflow: auto;
background-color: #fff;
font-size: 14px;
}
body {
font-family: 'Open Sans', sans-serif;
line-height: 1.5;
color: #4d4e53;
background-color: white;
}
a, a:visited, a:active {
color: #0095dd;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
header {
display: block;
padding: 0px 4px;
}
tt, code, kbd, samp {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
}
.class-description {
font-size: 130%;
line-height: 140%;
margin-bottom: 1em;
margin-top: 1em;
}
.class-description:empty {
margin: 0;
}
#main {
float: left;
width: 70%;
}
article dl {
margin-bottom: 40px;
}
section {
display: block;
background-color: #fff;
padding: 12px 24px;
border-bottom: 1px solid #ccc;
margin-right: 30px;
}
.variation {
display: none;
}
.signature-attributes {
font-size: 60%;
color: #aaa;
font-style: italic;
font-weight: lighter;
}
nav {
display: block;
float: right;
margin-top: 28px;
width: 30%;
box-sizing: border-box;
border-left: 1px solid #ccc;
padding-left: 16px;
}
nav ul {
font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
font-size: 100%;
line-height: 17px;
padding: 0;
margin: 0;
list-style-type: none;
}
nav ul a, nav ul a:visited, nav ul a:active {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
line-height: 18px;
color: #4D4E53;
}
nav h3 {
margin-top: 12px;
}
nav li {
margin-top: 6px;
}
footer {
display: block;
padding: 6px;
margin-top: 12px;
font-style: italic;
font-size: 90%;
}
h1, h2, h3, h4 {
font-weight: 200;
margin: 0;
}
h1 {
font-family: 'Open Sans Light', sans-serif;
font-size: 48px;
letter-spacing: -2px;
margin: 12px 24px 20px;
}
h2, h3 {
font-size: 30px;
font-weight: 700;
letter-spacing: -1px;
margin-bottom: 12px;
}
h4 {
font-size: 18px;
letter-spacing: -0.33px;
margin-bottom: 12px;
color: #4d4e53;
}
h5, .container-overview .subsection-title {
font-size: 120%;
font-weight: bold;
letter-spacing: -0.01em;
margin: 8px 0 3px 0;
}
h6 {
font-size: 100%;
letter-spacing: -0.01em;
margin: 6px 0 3px 0;
font-style: italic;
}
.ancestors {
color: #999;
}
.ancestors a {
color: #999 !important;
text-decoration: none;
}
.clear {
clear: both;
}
.important {
font-weight: bold;
color: #950B02;
}
.yes-def {
text-indent: -1000px;
}
.type-signature {
color: #aaa;
}
.name, .signature {
font-family: Consolas, Monaco, 'Andale Mono', monospace;
}
.details {
margin-top: 14px;
border-left: 2px solid #DDD;
}
.details dt {
width: 120px;
float: left;
padding-left: 10px;
padding-top: 6px;
}
.details dd {
margin-left: 70px;
}
.details ul {
margin: 0;
}
.details ul {
list-style-type: none;
}
.details li {
margin-left: 30px;
padding-top: 6px;
}
.details pre.prettyprint {
margin: 0
}
.details .object-value {
padding-top: 0;
}
.description {
margin-bottom: 1em;
margin-top: 1em;
}
.code-caption {
font-style: italic;
font-size: 107%;
margin: 0;
}
.prettyprint {
border: 1px solid #ddd;
width: 80%;
overflow: auto;
}
.prettyprint.source {
width: inherit;
}
.prettyprint code {
font-size: 100%;
line-height: 18px;
display: block;
padding: 4px 12px;
margin: 0;
background-color: #fff;
color: #4D4E53;
}
.prettyprint code span.line {
display: inline-block;
}
.prettyprint.linenums {
padding-left: 70px;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
.prettyprint.linenums ol {
padding-left: 0;
}
.prettyprint.linenums li {
border-left: 3px #ddd solid;
}
.prettyprint.linenums li.selected,
.prettyprint.linenums li.selected * {
background-color: lightyellow;
}
.prettyprint.linenums li * {
-webkit-user-select: text;
-moz-user-select: text;
-ms-user-select: text;
user-select: text;
}
.params, .props {
border-spacing: 0;
border: 0;
border-collapse: collapse;
}
.params .name, .props .name, .name code {
color: #4D4E53;
font-family: Consolas, Monaco, 'Andale Mono', monospace;
font-size: 100%;
}
.params td, .params th, .props td, .props th {
border: 1px solid #ddd;
margin: 0px;
text-align: left;
vertical-align: top;
padding: 4px 6px;
display: table-cell;
}
.params thead tr, .props thead tr {
background-color: #ddd;
font-weight: bold;
}
.params .params thead tr, .props .props thead tr {
background-color: #fff;
font-weight: bold;
}
.params th, .props th {
border-right: 1px solid #aaa;
}
.params thead .last, .props thead .last {
border-right: 1px solid #ddd;
}
.params td.description > p:first-child,
.props td.description > p:first-child {
margin-top: 0;
padding-top: 0;
}
.params td.description > p:last-child,
.props td.description > p:last-child {
margin-bottom: 0;
padding-bottom: 0;
}
.disabled {
color: #454545;
}
@@ -0,0 +1,111 @@
/* JSDoc prettify.js theme */
/* plain text */
.pln {
color: #000000;
font-weight: normal;
font-style: normal;
}
/* string content */
.str {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a keyword */
.kwd {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* a comment */
.com {
font-weight: normal;
font-style: italic;
}
/* a type name */
.typ {
color: #000000;
font-weight: normal;
font-style: normal;
}
/* a literal value */
.lit {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* punctuation */
.pun {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* lisp open bracket */
.opn {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* lisp close bracket */
.clo {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* a markup tag name */
.tag {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a markup attribute name */
.atn {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a markup attribute value */
.atv {
color: #006400;
font-weight: normal;
font-style: normal;
}
/* a declaration */
.dec {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* a variable name */
.var {
color: #000000;
font-weight: normal;
font-style: normal;
}
/* a function name */
.fun {
color: #000000;
font-weight: bold;
font-style: normal;
}
/* Specify class=linenums on a pre to get line numbering */
ol.linenums {
margin-top: 0;
margin-bottom: 0;
}
@@ -0,0 +1,163 @@
/* Tomorrow Theme */
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
/* Pretty printing styles. Used with prettify.js. */
/* SPAN elements with the classes below are added by prettyprint. */
/* plain text */
.pln {
color: #4d4d4c;
}
@media screen {
/* string content */
.str {
color: #718c00;
}
/* a keyword */
.kwd {
color: #8959a8;
}
/* a comment */
.com {
color: #8e908c;
}
/* a type name */
.typ {
color: #4271ae;
}
/* a literal value */
.lit {
color: #f5871f;
}
/* punctuation */
.pun {
color: #4d4d4c;
}
/* lisp open bracket */
.opn {
color: #4d4d4c;
}
/* lisp close bracket */
.clo {
color: #4d4d4c;
}
/* a markup tag name */
.tag {
color: #c82829;
}
/* a markup attribute name */
.atn {
color: #f5871f;
}
/* a markup attribute value */
.atv {
color: #3e999f;
}
/* a declaration */
.dec {
color: #f5871f;
}
/* a variable name */
.var {
color: #c82829;
}
/* a function name */
.fun {
color: #4271ae;
}
}
/* Use higher contrast and text-weight for printable form. */
@media print, projection {
.str {
color: #060;
}
.kwd {
color: #006;
font-weight: bold;
}
.com {
color: #600;
font-style: italic;
}
.typ {
color: #404;
font-weight: bold;
}
.lit {
color: #044;
}
.pun, .opn, .clo {
color: #440;
}
.tag {
color: #006;
font-weight: bold;
}
.atn {
color: #404;
}
.atv {
color: #060;
}
}
/* Style */
/*
pre.prettyprint {
background: white;
font-family: Consolas, Monaco, 'Andale Mono', monospace;
font-size: 12px;
line-height: 1.5;
border: 1px solid #ccc;
padding: 10px; }
*/
/* Specify class=linenums on a pre to get line numbering */
ol.linenums {
margin-top: 0;
margin-bottom: 0;
}
/* IE indents via margin-left */
li.L0,
li.L1,
li.L2,
li.L3,
li.L4,
li.L5,
li.L6,
li.L7,
li.L8,
li.L9 {
/* */
}
/* Alternate shading for lines */
li.L1,
li.L3,
li.L5,
li.L7,
li.L9 {
/* */
}
File diff suppressed because it is too large Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large Load Diff
File diff suppressed because one or more lines are too long
@@ -0,0 +1,15 @@
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" >
<svg xmlns="http://www.w3.org/2000/svg">
<metadata>Generated by IcoMoon</metadata>
<defs>
<font id="icomoon" horiz-adv-x="1024">
<font-face units-per-em="1024" ascent="960" descent="-64"/>
<missing-glyph horiz-adv-x="1024"/>
<glyph unicode="&#x20;" d="" horiz-adv-x="512"/>
<glyph unicode="&#xe1987;"
d="M726.954 68.236l-91.855-56.319-21.517 106.748 113.371-50.43zM876.293 709.493l12.502 28.106c6.469 14.545 23.659 21.147 38.201 14.681l60.652-26.984c14.546-6.468 21.149-23.661 14.68-38.201l-12.502-28.106-113.536 50.505zM720.236 424.478l116.041 260.86-7.209 69.019h-130.248l-233.736-522.358-245.476 522.358h-133.528l-71.266-742.442h82.462l47.785 562.498 264.047-562.498h43.141l252.85 562.498 15.14-149.939zM761.891 11.915l-6.068 60.094 117.030 263.097 33.757-323.192-144.719 0.001zM621.638 137.007l113.54-50.503 246.486 554.111-113.536 50.506-246.489-554.114z"
horiz-adv-x="1017"/>
</font>
</defs>
</svg>

After

Width:  |  Height:  |  Size: 1.1 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 323 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Some files were not shown because too many files have changed in this diff Show More