app/docs
2024-03-28 10:51:22 +08:00
..
.github/workflows docs: vuepress构建文档 2024-03-28 10:51:22 +08:00
.vuepress docs: vuepress构建文档 2024-03-28 10:50:19 +08:00
demo docs: vuepress构建文档 2024-03-28 10:50:19 +08:00
guide docs: vuepress构建文档 2024-03-28 10:50:19 +08:00
.gitignore docs: vuepress构建文档 2024-03-28 10:50:19 +08:00
README.md docs: vuepress构建文档 2024-03-28 10:50:19 +08:00

home icon title heroImage bgImage bgImageDark bgImageStyle heroText tagline actions highlights copyright footer
true home 项目主页 https://theme-hope-assets.vuejs.press/logo.svg https://theme-hope-assets.vuejs.press/bg/6-light.svg https://theme-hope-assets.vuejs.press/bg/6-dark.svg
background-attachment
fixed
项目名称 你可以在这里放置或是整个项目的描述。
text icon link type
使用指南 lightbulb ./demo/ primary
text link
文档 ./guide/
header image bgImage bgImageDark highlights
易于安装 /assets/image/box.svg https://theme-hope-assets.vuejs.press/bg/3-light.svg https://theme-hope-assets.vuejs.press/bg/3-dark.svg
title
运行 <code>pnpm create vuepress-theme-hope hope-project</code> 以创建一个新的主题项目。
title
在已有项目根目录下运行 <code>pnpm create vuepress-theme-hope add .</code> 以在项目中添加主题。
header description image bgImage bgImageDark bgImageStyle features
在 Markdown 中添加你想要的内容 我们扩展了标准的 CommonMark 规范,为你添加了成吨功能。 /assets/image/markdown.svg https://theme-hope-assets.vuejs.press/bg/2-light.svg https://theme-hope-assets.vuejs.press/bg/2-dark.svg
background-repeat background-size
repeat initial
title icon details link
链接检查 clipboard-check 检查 Markdown 链接 https://theme-hope.vuejs.press/zh/guide/markdown/others.html#link-check
title icon details link
提示容器支持 box-archive 用样式装饰 Markdown 内容 https://theme-hope.vuejs.press/zh/guide/markdown/hint.html
title icon details link
GFM 警告 bell GFM 风格的警告容器 https://theme-hope.vuejs.press/zh/guide/markdown/alert.html
title icon details link
选项卡 table-columns 使用选项卡对相似内容进行分组 https://theme-hope.vuejs.press/zh/guide/markdown/tabs.html
title icon details link
代码组 code 使用选项卡对相似代码进行分组 https://theme-hope.vuejs.press/zh/guide/markdown/code-tabs.html
title icon details link
自定义对齐支持 align-center 让你在 Markdown 中对段落进行对齐 https://theme-hope.vuejs.press/zh/guide/markdown/align.html
title icon details link
自定义属性支持 code 让你为 Markdown 元素添加属性 https://theme-hope.vuejs.press/zh/guide/markdown/attrs.html
title icon details link
上下角标支持 superscript 你的 Markdown 现在将支持上下角标 https://theme-hope.vuejs.press/zh/guide/markdown/sup-sub.html
title icon details link
脚注 quote-left 你的 Markdown 现在将支持脚注 https://theme-hope.vuejs.press/zh/guide/markdown/footnote.html
title icon details link
标记支持 highlighter 让你在 Markdown 中对词句进行标记 https://theme-hope.vuejs.press/zh/guide/markdown/mark.html
title icon details link
任务列表 square-check 在 Markdown 中使用任务列表 https://theme-hope.vuejs.press/zh/guide/markdown/tasklist.html
title icon details link
图片语法 image 使用改进的语法指定图片大小与颜色模式 https://theme-hope.vuejs.press/zh/guide/markdown/image.html
title icon details link
组件支持 puzzle-piece 在 Markdown 中轻松插入组件 https://theme-hope.vuejs.press/zh/guide/markdown/component.html
title icon details link
图表支持 chart-simple 在 Markdown 中展示图表 https://theme-hope.vuejs.press/zh/guide/markdown/chartjs.html
title icon details link
流程图支持 route 可以在 Markdown 中直接写出流程图 https://theme-hope.vuejs.press/zh/guide/markdown/flowchart.html
title icon details link
Mermaid 支持 chart-pie 可以在 Markdown 中添加 Mermaid 图例 https://theme-hope.vuejs.press/zh/guide/markdown/mermaid.html
title icon details link
Tex 支持 square-root-variable Markdown 现在也可以支持 Tex 语法以显示公式 https://theme-hope.vuejs.press/zh/guide/markdown/tex.html
title icon details link
导入文件支持 fab fa-markdown 将你的文档分段,并在 Markdown 中导入 https://theme-hope.vuejs.press/zh/guide/markdown/include.html
title icon details link
交互演示支持 code 你可以在 Markdown 中添加交互演示 https://theme-hope.vuejs.press/zh/guide/markdown/playground.html
title icon details link
Vue 交互演示支持 fab fa-vuejs 在交互演示中展示 Vue 组件 https://theme-hope.vuejs.press/zh/guide/markdown/vue-playground.html
title icon details link
Sandpack 交互演示支持 code Sandpack 驱动的实时的编码环境 https://theme-hope.vuejs.press/zh/guide/markdown/sandpack.html
title icon details link
代码案例支持 laptop-code 你可以很方便的插入代码案例 https://theme-hope.vuejs.press/zh/guide/markdown/demo.html
title icon details link
幻灯片支持 person-chalkboard 通过 Reveal.js 在 Markdown 中插入幻灯片 https://theme-hope.vuejs.press/zh/guide/markdown/revealjs.html
header description image bgImage bgImageDark highlights
布局 一个带有完整无障碍支持的响应式布局。 /assets/image/layout.svg https://theme-hope-assets.vuejs.press/bg/5-light.svg https://theme-hope-assets.vuejs.press/bg/5-dark.svg
title icon details link
布局增强 object-group 添加路径导航、页脚、改进的导航栏、改进的页面导航等。 https://theme-hope.vuejs.press/zh/guide/layout/
title icon details link
深色模式 circle-half-stroke 可以自由切换浅色模式与深色模式 https://theme-hope.vuejs.press/zh/guide/interface/darkmode.html
title icon details link
主题色切换 palette 支持自定义主题色并允许用户在预设的主题颜色之间切换 https://theme-hope.vuejs.press/zh/guide/interface/theme-color.html
title icon details link
幻灯片页面 person-chalkboard 添加幻灯片页面以显示你喜欢的内容 https://theme-hope.vuejs.press/zh/guide/layout/slides
title icon details link
更多 ellipsis RTL 布局,打印支持,全局按钮等 https://theme-hope.vuejs.press/zh/guide/interface/others.html
header image bgImage bgImageDark features
新功能 /assets/image/features.svg https://theme-hope-assets.vuejs.press/bg/1-light.svg https://theme-hope-assets.vuejs.press/bg/1-dark.svg
title icon details link
浏览量与评论 comment-dots 配合 Waline 来开启阅读量统计与评论支持 https://theme-hope.vuejs.press/zh/guide/feature/comment.html
title icon details link
文章信息 circle-info 为你的文章添加作者、写作日期、预计阅读时间、字数统计等信息 https://theme-hope.vuejs.press/zh/guide/feature/page-info.html
title icon details link
文章加密 lock 你可以为你的特定页面或特定目录进行加密,以便陌生人不能随意访问它们 https://theme-hope.vuejs.press/zh/guide/feature/encrypt.html
title icon details link
搜索支持 search 支持 docsearch 和基于客户端的搜索 https://theme-hope.vuejs.press/zh/guide/feature/search.html
title icon details link
代码复制 copy 一键复制代码块中的代码 https://theme-hope.vuejs.press/zh/guide/feature/copy-code.html
title icon details link
图片预览 image 像相册一样允许你浏览、缩放并分享你的页面图片 https://theme-hope.vuejs.press/zh/guide/feature/photo-swipe.html
header description image bgImage bgImageDark highlights
博客 通过主题创建个人博客 /assets/image/blog.svg https://theme-hope-assets.vuejs.press/bg/5-light.svg https://theme-hope-assets.vuejs.press/bg/5-dark.svg
title icon details link
博客功能 blog 通过文章的日期、标签和分类展示文章 https://theme-hope.vuejs.press/zh/guide/blog/intro.html
title icon details link
博客主页 home 全新博客主页 https://theme-hope.vuejs.press/zh/guide/blog/home.html
title icon details link
博主信息 home 自定义名称、头像、座右铭和社交媒体链接 https://theme-hope.vuejs.press/zh/guide/blog/blogger.html
title icon details link
时间线 home 在时间线中浏览和通读博文 https://theme-hope.vuejs.press/zh/guide/blog/timeline.html
header description image bgImage bgImageDark highlights
高级 增强站点与用户体验的高级功能 /assets/image/advanced.svg https://theme-hope-assets.vuejs.press/bg/4-light.svg https://theme-hope-assets.vuejs.press/bg/4-dark.svg
title icon details link
SEO 增强 dumbbell 将最终生成的网页针对搜索引擎进行优化。 https://theme-hope.vuejs.press/zh/guide/advanced/seo.html
title icon details link
Sitemap sitemap 自动为你的网站生成 Sitemap https://theme-hope.vuejs.press/zh/guide/advanced/sitemap.html
title icon details link
Feed 支持 rss 生成你的 Feed并通知你的用户订阅它 https://theme-hope.vuejs.press/zh/guide/advanced/feed.html
title icon details link
PWA 支持 mobile-screen 让你的网站更像一个 APP https://theme-hope.vuejs.press/zh/guide/advanced/pwa.html
false 使用 <a href="https://theme-hope.vuejs.press/zh/" target="_blank">VuePress Theme Hope</a> 主题 | MIT 协议, 版权所有 © 2019-present Mr.Hope

这是项目主页的案例。你可以在这里放置你的主体内容。

想要使用此布局,你需要在页面 front matter 中设置 home: true

配置项的相关说明详见 项目主页配置