1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="UTF-8"/><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"/><meta name="apple-mobile-web-app-capable" content="yes"/><meta name="apple-mobile-web-app-status-bar-style" content="black"/><link rel="apple-touch-icon" sizes="180x180" href="ydoc/images/apple-touch-icon.png"/><link rel="icon" type="image/png" sizes="32x32" href="ydoc/images/favicon-32x32.png"/><link rel="icon" type="image/png" sizes="16x16" href="ydoc/images/favicon-16x16.png"/><link rel="manifest" href="ydoc/images/manifest.json"/><link rel="mask-icon" href="ydoc/images/safari-pinned-tab.svg" color="#5bbad5"/><meta name="theme-color" content="#ffffff"/><meta http-equiv="Cache-Control" content="no-transform"/><meta http-equiv="Cache-Control" content="no-siteapp"/><title>标准插件-ydoc</title><link rel="stylesheet" href="ydoc/styles/style.css"/><meta name="author" content="ymfe"/><meta name="keywords"/><meta name="description" content="ydoc description demo"/><meta id="releativePath" content=""/><link rel="stylesheet" href="ydoc/ydoc-plugin-edit-page/editPage.css"/></head><body><div class="g-doc"><div class="m-aside"><div class="m-summary" id="js-menu"><div class="m-summary-content" id="js-menu-content"><div class="m-summary-block"><ul class="m-summary-list"><li class="item"><a href="index.html" class="href">插件介绍</a></li></ul></div><div class="m-summary-block"><div class="m-summary-title">技巧</div><ul class="m-summary-list indent"><li class="item"><a href="plugin-inner.html" class="href">内置插件</a></li><li class="item"><a href="" class="href">标准插件</a></li><li class="item"><a href="plugin-markdown-it.html" class="href">markdown-it 插件</a></li></ul></div></div></div><div class="m-summary-switch" id="js-summary-switch"><svg viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15" class="bottom"><g transform="translate(904.92214,-879.1482)"><path d="m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,-174.68583 0.6895,0 26.281,25.03215 56.8701,55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,-104.0616 -231.873,-231.248 z" fill="#fff"></path></g></svg><svg viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15" class="top"><g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"><g id="aaa" fill="#fff" fill-rule="nonzero"><path d="M231.2455,342.502 L0,111.25397 L55.6165,55.62697 C86.2056,25.03212 111.7971,-2.99999998e-05 112.4866,-2.99999998e-05 C113.176,-2.99999998e-05 192.3503,78.60859 288.4293,174.6858 L463.1185,349.3716 L637.8077,174.6858 C733.8867,78.60859 813.060896,-2.99999997e-05 813.750396,-2.99999997e-05 C814.439896,-2.99999997e-05 840.031396,25.03212 870.620496,55.62697 L926.236996,111.25397 L694.9915,342.502 C567.8065,469.6884 463.4636,573.75 463.1185,573.75 C462.7734,573.75 358.4305,469.6884 231.2455,342.502 Z" id="Shape" transform="translate(463.118498, 286.874985) scale(1, -1) translate(-463.118498, -286.874985) "></path></g></g></svg></div></div><div class="m-main" id="js-panel"><header class="m-header" id="js-header"><div class="m-header-title js-logo"><a href="index.html" target="_self"><img class="logo" width="36" src="ydoc/images/dog@1x.png"/><h6 class="name">YDoc</h6></a></div><div></div><nav class="m-header-nav js-nav"><ul class="m-header-items"></ul></nav><div id="js-nav-btn" class="m-header-btn ui-font-ydoc"></div></header><div class="m-content" id="js-content"><div id="markdown-body" class="m-content-container markdown-body"><h1>标准插件</h1>
<p>请访问 <a href="https://ydoc.ymfe.org/plugin/index.html" target="_blank">ydoc 官网 - 插件</a> 浏览插件。</p>
<h2 id="试一试">试一试</h2>
<p>现在我们来安装 <a href="https://www.npmjs.com/package/ydoc-plugin-edit-page" target="_blank">edit-page 插件</a></p>
<p>首先 install 这个模块：</p>
<pre><code class="language-bash"><span class="token function">npm</span> <span class="token function">install</span> --save-dev ydoc-plugin-demo
</code></pre>
<p>在 ydoc.json 中配置该插件：</p>
<pre><code class="language-json"><span class="token punctuation">{</span>
<span class="token property">"plugins"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"edit-page"</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token property">"pluginsConfig"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property">"edit-page"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
prefix<span class="token operator">:</span> <span class="token string">"https://github.com/YMFE/ydoc/tree/master/docs"</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre>
<h2 id="插件配置">插件配置</h2>
<p>上面配置的 <code>"edit-page"</code> 插件使用了自定义配置, 对于该插件的配置，可以在 ydoc.json 中的 <code>"pluginsConfig"</code> 字段添加如下配置：</p>
<pre><code class="language-json"><span class="token punctuation">{</span>
<span class="token property">"pluginsConfig"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property">"edit-page"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
prefix<span class="token operator">:</span> <span class="token string">"https://github.com/YMFE/ydoc/tree/master/docs"</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre>
<p>这时使用 <code>ydoc serve</code> 命令启动本地服务，即可在浏览器中的页面底部看到 "编辑此页面" 的链接 (ydoc build 命令由于生成的是静态地址，因此不会生成此链接)</p>
</div><div class="m-content-container m-paging"><div class="m-paging-prev m-paging-item"><a href="plugin-inner.html" class="href"><span class="ui-font-ydoc"></span>内置插件</a></div><div class="m-paging-next m-paging-item"><a href="plugin-markdown-it.html" class="href">markdown-it 插件<span class="ui-font-ydoc"></span></a></div></div></div></div></div><div></div><script>
var $content = document.getElementById('js-content');
var $summaryItems = Array.prototype.slice.call(document.querySelectorAll('#js-menu .href'));
var $menu = document.getElementById('js-menu');
if ($menu && sessionStorage.menuScrollTop) {
$menu.scrollTop = sessionStorage.menuScrollTop;
}
// 刷新页面但不切换 pathname 的时候，内容区恢复到记忆的高度
if ($content && sessionStorage.contentScrollTop && window.location.pathname == sessionStorage.locationPathname) {
$content.scrollTop = sessionStorage.contentScrollTop;
}
sessionStorage.setItem('locationPathname', window.location.pathname);</script><script src="ydoc/scripts/plugins/dollar.min.js"></script><script src="ydoc/scripts/plugins/responsive-nav.min.js"></script><script src="ydoc/scripts/plugins/slideout.min.js"></script><script src="ydoc/scripts/app.js"></script><script src="ydoc/ydoc-plugin-edit-page/edit.script.js"></script><script src="edit_json.js"></script></body></html>