Vuejs 官方团队新项目:VuePress 由 Vue 驱动的静态页面生成器

file

VuePress 是来自 Vue.js 的创始人 Evan You 的一款由 Vue 驱动的静态站点的简约的生成器。 它的构建是为了支持Vue项目的文档需求。 默认情况下,对技术文档生成的主题针进行了优化.

VuePress 站点是一个单页应用,在构建中,通过访问每个路由来创建服务器所呈现的版本。 VuePress 是由 Vue 、Vue Router 和 Webpack驱动的,所以你也可以在你的 markdown 中使用它。

VuePress 入门

你可以快速将使用 Markdown 格式编写的文档添加到现有项目中,以下示例来自 getting started 作为快速入门示例:

# 作为本地依赖安装
yarn add -D vuepress # 或者 npm install -D vuepress

# 创建文档目录
mkdir docs
# 创建 markdown 文件
echo '# Hello VuePress' > docs/README.md

在编写内容时,浏览器会实时更新,这在构建文档时非常有用。

功能

.vuepress/components 中的 Vue 组件会自动注册为全局异步组件,这些组件可以直接在 Markdown 文档中使用。

Markdown 文件首先会编译为 HTML 并作为 Vue 组件传递给 vue-loader ,你可以使用 Vue 模板语法访问站点数据:

{{ 5 + 5 }}

{{ $page }}

VuePress 允许通过单个 Vue 组件使用自定义主题。你可以在  .vuepress/themes/Layout.vue 中创建和组织一个自定义主题。 你可以使用 vuepress-theme-xxx NPM 包自定义主题,在以下示例中使用的是 vuepress-theme-cobalt

module.exports = {
  theme: 'cobalt'
}

你可以使用 Markdown 扩展,包括 YAML You can use Markdown extensions including YAML 语言、表情符号、Github 风格的表格和自定义元素:

::: danger STOP
Danger zone, do not proceed
:::

生成后就会像下面的默认主题:

Example Custom Block

关于更多

入门可以查看 官方网站。如果你想通过一个实战例子开始学习,可以查看由 vuepress.vuejs.org 提供的VuePress 文档

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://laravel-news.com/vuepress

译文地址:https://learnku.com/vuejs/t/23278/vuejs-...

本文为协同翻译文章,如您发现瑕疵请点击「改进」按钮提交优化建议
讨论数量: 3

这个如何作为Laravel的项目文档使用呢?

要是能出个教程就好了.

4年前 评论
cnguu

已折腾,现在是我的一个静态博客了 :joy:

4年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!