介绍

    • 更有深度:为了避免指南写得太长,我们试着只包含了尽可能简单的示例来帮助你理解每个功能,然后就奔下一个话题了。在 cookbook 里,我们以更生动的形式包含了更复杂的示例并结合特性。每个案例都可以尽可能的翔实,以彻底探索这个领域。

    • 传授 JavaScript:在指南里,我们假设你至少具有 ES5 JavaScript 的中级水平。例如,我们不会解释 在计算属性中是如何过滤一个列表的。然而在 cookbook 里,我们将对一些必要的 JavaScript 特性 (包括 ES6/2015+) 进行探索和解释,以帮助我们构建更好的 Vue 应用。

    • 探索生态系统:对于高级特性,我们会假设你已经对生态系统有一定了解。例如,如果你想在 webpack 中使用单文件组件,我们不会解释如何在 webpack 中配置 Vue 以外的部分。在 cookbook 里,我们有空间去更深度探索这些生态系统中的库——至少能到对 Vue 开发者普遍使用的程度。

    除了这些不同,请注意这份 cookbook 仍不是入门教程。其大部分内容都假设你已经理解 HTML、CSS、JavaScript、npm/yarn 等基本概念。

    如果你有兴趣参与贡献,请将您的想法填入 issue 并加上 cookbook idea 的标签作为起步,这样我们就可以帮助并引导您完成一个 pull request。在你的想法被认同之后,请尽可能遵循以下模板。有些小节是必须的,有些是可选的。我们强烈建议您遵循其顺序,但这也不是必须的。通常情况下案例应该:

    我们需要您遵照下面的模板。当然我们也理解有的时候为了使内容更清晰或顺畅你是有必要做一些调整的。另外不论怎样,所有的案例都应该从某些点上讨论选择使用这个模式的细微差别,且我们倾向于它们以替代方案章节的形式出现。

    基本的示例

    必须的

    • 用一两句话来说明问题。
    • 用一两句话解释最简单的可能的解决方案。
    • 显示一小段代码示例。
    • 用一句话解释它完成了什么。

    必须的

    • 解决人们在看例子时可能遇到的常见问题。(最好以块引用格式呈现)
    • 显示常见错误的例子,以及如何避免它们。
    • 用非常简单的代码示例展示好模式和坏模式。
    • 讨论这个模式令人信服的理由。参考链接不是必需的,但鼓励提供。

    实际的例子

    必须的

    • 通过几个简单的设置例子,或者
    • 嵌入一个 CodePen / JSFiddle 的例子如果你选择稍后再提供,那么你仍应该表述它是什么和做什么。

    可选的

    为这个模式写点东西,描述在这个模式下,它会应用到什么地方,为什么它能正常工作;以及在此基础上运行一些代码、提供一些延伸阅读材料,都是非常有帮助的。

    何时避免这个模式

    可选的

    本节不是必需的,但强烈建议。你没有必要写一些特别简单易懂的事项,比如根据状态的改变开关 class,但是对于 mixin 这样的更高阶的模式来说是非常重要的。大多数高阶的问题的答案都是,该部分就包含了这一点。在此,我们要诚实地看待模式何时有用,何时应该避免,什么时候更有意义。

    可选的,除非这部分内容在之前已经提供过了

    文档贡献是需要很多时间的,如果您花时间提交这部分的文档,我们将感激不尽。