返回介绍

模板与变量

发布于 2021-04-22 14:22:45 字数 4283 浏览 1092 评论 0 收藏 0

YDoc 主题的模板是若干的 jsx 组件,以下是各模板文件相对应的功能(按首字母排序):

模板功能
Content.jsx文档页内容
Footer.jsx (用户自定义组件)Footer 信息
Head.jsxhtml 文件中 部分的内容
Header.jsx顶部导航
Homepage.jsx (用户自定义组件)文档站首页
Hook.jsx钩子,用于自定义插件
Icon.jsxfavicon 图片
Layout.jsxhtml 文件,其他组件的入口
Logo.jsx配置网站的 logo
Scripts.jsxscript 脚本
Summary.jsx侧栏目录

有的模板中使用了 YDoc 提供的 变量 ,这些变量可以在当前模板文件中任意位置使用,因此你可以灵活定制自己的主题,变量列表如下:

变量

Content.jsx(文档页内容)

变量描述
props.distPath当前页面路径
props.type内容类型, markdown 页面为 'md'
props.content页面内容,一段 html
props.prev上一页信息
props.prev.distPath上一页的相对路径
props.prev.title上一页的页面标题
props.next下一页信息
props.next.distPath下一页的相对路径
props.next.title下一页的页面标题

Head.jsx(html 文件中 部分的内容)

变量描述
props.distPath当前页面路径
props.title当前页面标题
props.config.author网站作者
props.config.keywords网站关键字
props.config.description网站描述
props.assets.css钩子中的 css 路径

Header.jsx(顶部导航)

变量描述
props.distPath当前页面路径
props.title当前页面标题
props.config.author网站作者
props.config.keywords网站关键字
props.config.description网站描述
props.assets.css钩子中的 css 路径
props.ydoc顶级 props
props.ydoc.bookpathbook 路径

Icon.jsx

变量描述
props.distPath当前页面路径

Layout.jsx

变量描述
props.distPath当前页面路径
props.summary侧栏目录配置
props.config配置信息(ydoc 配置)
props.assets钩子中的 assets 配置
props.title当前页面标题
props.page页面信息

Logo.jsx

变量描述
props.distPath当前页面路径
props.nav顶部导航信息(配置在 NAV.md 中)
props.nav.logologo
props.nav.titlelogo 旁的标题

Scripts.jsx

变量描述
props.page.distPath当前页面路径

Summary.jsx

变量描述
props.summary侧栏目录
props.releativePath目录项的相对路径

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文