san website

prepare

$ npm i

preview

hexo s

deploy

$ hexo deploy

给 san 文档做贡献

san是一个传统的MVVM组件框架,官网地址https://ecomfe.github.io/san/

如果你在使用san过程中有任何问题,请通过github:https://github.com/ecomfe/san 给我们提issue; 如果你在看你san文档的过程中发现任何问题,可以通过文档github:https://github.com/ecomfe/san-website, 给我们提issue,或者在相应位置修改后发起pr; 当然我们非常欢迎您在实践san框架过程中,有任何实践经验和总结文档,可以通过pr的方式提交到文档github:https://github.com/ecomfe/san-website, 经过我们review后的文档会合入san的官方文档中

san文档pr规范

  1. 提交前的fork同步更新操作:每次pr前请进行fork同步更新操作,避免产生冲突

  2. 文档内容: 必须包含对实践问题的原理分析总结,包含实际的demo,demo的编写请使用codepen,最后将其嵌入到文档中,具体详情及嵌入方式请见例子: https://ecomfe.github.io/san/practice/traverse-object/

  3. 实践类文档项目路径

    • 添加文档可以往这里发pr

         https://github.com/ecomfe/san-website/tree/master/source/_posts/practice ,
      
    • 链接是手工加

        https://github.com/ecomfe/san-website/blob/master/themes/san/layout/practice.ejs
      
  4. pr标题与内容:pr标题和内容,请对文档进行详细说明,并提供文档的最终截图

有任何文档问题可以给我们提issue