ydoc

<!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>模板与变量-文档</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-search/search.css"/><link rel="stylesheet" href="../ydoc/ydoc-plugin-edit-page/editPage.css"/><link rel="stylesheet" href="../custom.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="structure.html" class="href">目录结构</a></li><li class="item"><a href="nav.html" class="href">导航</a></li><li class="item"><div class="m-summary-block"><a href="pages-index.html" class="href">页面</a><ul class="m-summary-list indent"><li class="item"><a href="pages-index.html" class="href">首页</a></li><li class="item"><a href="pages-book.html" class="href">文档页</a></li><li class="item"><a href="pages-custom.html" class="href">自定义页面</a></li></ul></div></li><li class="item"><a href="config.html" class="href">配置文件</a></li><li class="item"><a href="markdown.html" class="href">Markdown</a></li></ul></div><div class="m-summary-block"><div class="m-summary-title">命令</div><ul class="m-summary-list indent"><li class="item"><div class="m-summary-block"><a href="command-index.html" class="href">页面</a><ul class="m-summary-list indent"><li class="item"><a href="command-index.html#init-初始化" class="href">init 初始化</a></li><li class="item"><a href="command-index.html#build-构建" class="href">build 构建</a></li><li class="item"><a href="command-index.html#serve-服务" class="href">serve 服务</a></li><li class="item"><a href="command-index.html#theme-主题" class="href">theme 主题</a></li></ul></div></li></ul></div><div class="m-summary-block"><div class="m-summary-title">自定义</div><ul class="m-summary-list indent"><li class="item"><div class="m-summary-block"><a href="theme.html" class="href">主题</a><ul class="m-summary-list indent"><li class="item"><a href="" class="href">模板与变量</a></li></ul></div></li><li class="item"><a href="jsx.html" class="href">JSX</a></li><li class="item"><div class="m-summary-block"><a href="plugins.html" class="href">扩展</a><ul class="m-summary-list indent"><li class="item"><a href="create.html" class="href">创建插件</a></li><li class="item"><a href="hooks.html" class="href">Hooks</a></li><li class="item"><a href="markdown-it.html" class="href">markdown扩展</a></li></ul></div></li><li class="item"><div class="m-summary-block"><a href="qa.html" class="href">常见问题</a><ul class="m-summary-list indent"><li class="item"><a href="qa.html#%e6%9b%bf%e6%8d%a2-favicon" class="href">替换 favicon</a></li><li class="item"><a href="qa.html#%e5%bc%95%e5%85%a5-js-%e5%92%8c-css" class="href">引入 js 和 css</a></li></ul></div></li></ul></div><div class="m-summary-block"><ul class="m-summary-list"><li class="item"><a href="release.html" class="href">版本历史</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" srcSet="../ydoc/images/dog@2x.png 2x"/><h6 class="name">YDoc</h6></a></div><div><div class="m-search"> <div class="icon"></div> <input type="text" class="input js-input" placeholder="搜索" /> <div class="m-search-result js-search-result"></div> </div></div><nav class="m-header-nav js-nav"><ul class="m-header-items"><li class="item active"><a class="href" href="index.html">文档</a></li><li class="item "><a class="href" href="../plugin/index.html">插件</a></li><li class="item "><a class="href" href="../theme/index.html">主题</a></li><li class="item "><a class="href" href="../examples/index.html">示例 Demo</a></li><li class="item "><span class="href">规范</span><ul class="m-header-subtitle"><li class="item"><a href="../standard/style-guide.html" class="link">设计规范</a></li><li class="item"><a href="../standard/index.html" class="link">文档规范</a></li></ul></li></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>YDoc 主题的模板是若干的 jsx 组件，以下是各模板文件相对应的功能（按首字母排序）：</p> <table> <thead> <tr> <th>模板</th> <th>功能</th> </tr> </thead> <tbody> <tr> <td><code>Content.jsx</code></td> <td>文档页内容</td> </tr> <tr> <td><code>Footer.jsx</code> (用户自定义组件)</td> <td>Footer 信息</td> </tr> <tr> <td><code>Head.jsx</code></td> <td>html 文件中 <head> 部分的内容</head></td> </tr> <tr> <td><code>Header.jsx</code></td> <td>顶部导航</td> </tr> <tr> <td><code>Homepage.jsx</code> (用户自定义组件)</td> <td>文档站首页</td> </tr> <tr> <td><code>Hook.jsx</code></td> <td>钩子，用于自定义插件</td> </tr> <tr> <td><code>Icon.jsx</code></td> <td>favicon 图片</td> </tr> <tr> <td><code>Layout.jsx</code></td> <td>html 文件，其他组件的入口</td> </tr> <tr> <td><code>Logo.jsx</code></td> <td>配置网站的 logo</td> </tr> <tr> <td><code>Scripts.jsx</code></td> <td>script 脚本</td> </tr> <tr> <td><code>Summary.jsx</code></td> <td>侧栏目录</td> </tr> </tbody> </table> <p>有的模板中使用了 YDoc 提供的 <code>变量</code> ，这些变量可以在当前模板文件中任意位置使用，因此你可以灵活定制自己的主题，变量列表如下：</p> <h2 id="变量">变量</h2> <h3 id="变量-content.jsx（文档页内容）">Content.jsx（文档页内容）</h3> <table> <thead> <tr> <th>变量</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td><code>props.distPath</code></td> <td>当前页面路径</td> </tr> <tr> <td><code>props.type</code></td> <td>内容类型, markdown 页面为 'md'</td> </tr> <tr> <td><code>props.content</code></td> <td>页面内容，一段 html</td> </tr> <tr> <td><code>props.prev</code></td> <td>上一页信息</td> </tr> <tr> <td><code>props.prev.distPath</code></td> <td>上一页的相对路径</td> </tr> <tr> <td><code>props.prev.title</code></td> <td>上一页的页面标题</td> </tr> <tr> <td><code>props.next</code></td> <td>下一页信息</td> </tr> <tr> <td><code>props.next.distPath</code></td> <td>下一页的相对路径</td> </tr> <tr> <td><code>props.next.title</code></td> <td>下一页的页面标题</td> </tr> </tbody> </table> <h3 id="变量-head.jsx（html-文件中-部分的内容）">Head.jsx（html 文件中 <head> 部分的内容）</head></h3> <table> <thead> <tr> <th>变量</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td><code>props.distPath</code></td> <td>当前页面路径</td> </tr> <tr> <td><code>props.title</code></td> <td>当前页面标题</td> </tr> <tr> <td><code>props.config.author</code></td> <td>网站作者</td> </tr> <tr> <td><code>props.config.keywords</code></td> <td>网站关键字</td> </tr> <tr> <td><code>props.config.description</code></td> <td>网站描述</td> </tr> <tr> <td><code>props.assets.css</code></td> <td>钩子中的 css 路径</td> </tr> </tbody> </table> <h3 id="变量-header.jsx（顶部导航）">Header.jsx（顶部导航）</h3> <table> <thead> <tr> <th>变量</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td><code>props.distPath</code></td> <td>当前页面路径</td> </tr> <tr> <td><code>props.title</code></td> <td>当前页面标题</td> </tr> <tr> <td><code>props.config.author</code></td> <td>网站作者</td> </tr> <tr> <td><code>props.config.keywords</code></td> <td>网站关键字</td> </tr> <tr> <td><code>props.config.description</code></td> <td>网站描述</td> </tr> <tr> <td><code>props.assets.css</code></td> <td>钩子中的 css 路径</td> </tr> <tr> <td><code>props.ydoc</code></td> <td>顶级 props</td> </tr> <tr> <td><code>props.ydoc.bookpath</code></td> <td>book 路径</td> </tr> </tbody> </table> <h3 id="变量-icon.jsx">Icon.jsx</h3> <table> <thead> <tr> <th>变量</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td><code>props.distPath</code></td> <td>当前页面路径</td> </tr> </tbody> </table> <h3 id="变量-layout.jsx">Layout.jsx</h3> <table> <thead> <tr> <th>变量</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td><code>props.distPath</code></td> <td>当前页面路径</td> </tr> <tr> <td><code>props.summary</code></td> <td>侧栏目录配置</td> </tr> <tr> <td><code>props.config</code></td> <td>配置信息（ydoc 配置）</td> </tr> <tr> <td><code>props.assets</code></td> <td>钩子中的 assets 配置</td> </tr> <tr> <td><code>props.title</code></td> <td>当前页面标题</td> </tr> <tr> <td><code>props.page</code></td> <td>页面信息</td> </tr> </tbody> </table> <h3 id="变量-logo.jsx">Logo.jsx</h3> <table> <thead> <tr> <th>变量</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td><code>props.distPath</code></td> <td>当前页面路径</td> </tr> <tr> <td><code>props.nav</code></td> <td>顶部导航信息（配置在 NAV.md 中）</td> </tr> <tr> <td><code>props.nav.logo</code></td> <td>logo</td> </tr> <tr> <td><code>props.nav.title</code></td> <td>logo 旁的标题</td> </tr> </tbody> </table> <h3 id="变量-scripts.jsx">Scripts.jsx</h3> <table> <thead> <tr> <th>变量</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td><code>props.page.distPath</code></td> <td>当前页面路径</td> </tr> </tbody> </table> <h3 id="变量-summary.jsx">Summary.jsx</h3> <table> <thead> <tr> <th>变量</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td><code>props.summary</code></td> <td>侧栏目录</td> </tr> <tr> <td><code>props.releativePath</code></td> <td>目录项的相对路径</td> </tr> </tbody> </table> </div><div class="m-content-container m-paging"><div class="m-paging-prev m-paging-item"><a href="theme.html" class="href"><span class="ui-font-ydoc"></span>主题</a></div><div class="m-paging-next m-paging-item"><a href="jsx.html" class="href">JSX<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 (sessionStorage.prevPathname) { sessionStorage.setItem('prevPrevPathname', sessionStorage.prevPathname); sessionStorage.setItem('prevPrevMenuScrollTop', sessionStorage.prevMenuScrollTop); sessionStorage.setItem('prevPrevContentScrollTop', sessionStorage.prevContentScrollTop); } if (sessionStorage.locationPathname) { sessionStorage.setItem('prevPathname', sessionStorage.locationPathname); sessionStorage.setItem('prevMenuScrollTop', sessionStorage.menuScrollTop); sessionStorage.setItem('prevContentScrollTop', sessionStorage.contentScrollTop); } if ($menu && sessionStorage.menuScrollTop) { $menu.scrollTop = sessionStorage.menuScrollTop; } // 刷新页面但不切换 pathname 的时候，内容区恢复到记忆的高度 if ($content && sessionStorage.contentScrollTop && window.location.pathname == sessionStorage.locationPathname) { $content.scrollTop = sessionStorage.contentScrollTop; } else if (sessionStorage.prevPrevPathname && sessionStorage.prevPrevPathname === window.location.pathname) { if ($menu && sessionStorage.prevPrevMenuScrollTop) { $menu.scrollTop = sessionStorage.prevPrevMenuScrollTop; } if ($content && sessionStorage.prevPrevContentScrollTop) { $content.scrollTop = sessionStorage.prevPrevContentScrollTop; } } 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-search/core.js"></script><script src="../ydoc/ydoc-plugin-search/search.js"></script><script src="../ydoc/ydoc-plugin-edit-page/edit.script.js"></script><script src="../search_json.js"></script><script src="../edit_json.js"></script></body></html>