[Doc] add introduction page (#452)

2025-10-18 09:24:25 +00:00 · 2017-12-19 13:08:09 +08:00
parent 79a2b13b63
commit 02a8c2a592
13 changed files with 161 additions and 38 deletions
--- a/docs/markdown/en-US/i18n.md
+++ b/docs/markdown/en-US/i18n.md
@@ -1,4 +1,4 @@
-# Internationalization
+## Internationalization
 The default language of Vant is Chinese. If you want to use other languages, you can follow the instructions below.

 ### Switch languages
--- a/docs/markdown/en-US/intro.md
+++ b/docs/markdown/en-US/intro.md
@@ -0,0 +1,38 @@
+<div class="van-doc-intro">
+  <img class="van-doc-intro__youzan" src="//img.yzcdn.cn/public_files/2017/02/09/e84aa8cbbf7852688c86218c1f3bbf17.png">
+  <img class="van-doc-intro__logo" src="//img.yzcdn.cn/public_files/2017/12/18/fd78cf6bb5d12e2a119d0576bedfd230.png">
+  <h2>Vant</h2>
+  <p>A Vue.js 2.0 Mobile UI at YouZan</p>
+</div>
+ 
+### Features
+
+* 48+ Reusable components
+* 90%+ Unit test coverage
+* Extensive documentation and demos
+* Support [babel-plugin-import](https://github.com/ant-design/babel-plugin-import)
+* Support TypeScript
+* Support SSR
+
+### Quickstart
+
+See in [Quickstart](https://www.youzanyun.com/zanui/vant#/en-US/component/quickstart).
+
+### Contribution
+
+Please make sure to read the [Contributing Guide](https://github.com/youzan/vant/blob/dev/.github/CONTRIBUTING.md) before making a pull request.
+
+### Browser Support
+
+Modern browsers and Android 4.0+, iOS 6+.
+
+### Links
+
+* [Changelog](https://www.youzanyun.com/zanui/vant#/en-US/component/changelog)
+* [Weapp UI](https://github.com/youzan/zanui-weapp)
+* [Vant Demo](https://github.com/youzan/vant-demo)
+* [vue-cli-template-vant](https://github.com/youzan/vue-cli-template-vant)
+
+### LICENSE
+
+[MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89)
--- a/docs/markdown/index.js
+++ b/docs/markdown/index.js
@@ -35,6 +35,7 @@ export default {
  'zh-CN/i18n': wrapper(r => require.ensure([], () => r(require('./zh-CN/i18n.md')), 'zh-CN/i18n')),
  'zh-CN/icon': wrapper(r => require.ensure([], () => r(require('./zh-CN/icon.md')), 'zh-CN/icon')),
  'zh-CN/image-preview': wrapper(r => require.ensure([], () => r(require('./zh-CN/image-preview.md')), 'zh-CN/image-preview')),
+  'zh-CN/intro': wrapper(r => require.ensure([], () => r(require('./zh-CN/intro.md')), 'zh-CN/intro')),
  'zh-CN/layout': wrapper(r => require.ensure([], () => r(require('./zh-CN/layout.md')), 'zh-CN/layout')),
  'zh-CN/lazyload': wrapper(r => require.ensure([], () => r(require('./zh-CN/lazyload.md')), 'zh-CN/lazyload')),
  'zh-CN/loading': wrapper(r => require.ensure([], () => r(require('./zh-CN/loading.md')), 'zh-CN/loading')),
@@ -86,6 +87,7 @@ export default {
  'en-US/i18n': wrapper(r => require.ensure([], () => r(require('./en-US/i18n.md')), 'en-US/i18n')),
  'en-US/icon': wrapper(r => require.ensure([], () => r(require('./en-US/icon.md')), 'en-US/icon')),
  'en-US/image-preview': wrapper(r => require.ensure([], () => r(require('./en-US/image-preview.md')), 'en-US/image-preview')),
+  'en-US/intro': wrapper(r => require.ensure([], () => r(require('./en-US/intro.md')), 'en-US/intro')),
  'en-US/layout': wrapper(r => require.ensure([], () => r(require('./en-US/layout.md')), 'en-US/layout')),
  'en-US/lazyload': wrapper(r => require.ensure([], () => r(require('./en-US/lazyload.md')), 'en-US/lazyload')),
  'en-US/loading': wrapper(r => require.ensure([], () => r(require('./en-US/loading.md')), 'en-US/loading')),
--- a/docs/markdown/zh-CN/i18n.md
+++ b/docs/markdown/zh-CN/i18n.md
@@ -1,4 +1,4 @@
-# 国际化
+## 国际化
 Vant 默认采用中文作为语言，如果需要使用其他语言，可以参考下面的方案

 ### 多语言切换
--- a/docs/markdown/zh-CN/intro.md
+++ b/docs/markdown/zh-CN/intro.md
@@ -0,0 +1,40 @@
+<div class="van-doc-intro">
+  <img class="van-doc-intro__youzan" src="//img.yzcdn.cn/public_files/2017/02/09/e84aa8cbbf7852688c86218c1f3bbf17.png">
+  <img class="van-doc-intro__logo" src="//img.yzcdn.cn/public_files/2017/12/18/fd78cf6bb5d12e2a119d0576bedfd230.png">
+  <h2>Vant</h2>
+  <p>有赞移动端 Vue 组件库</p>
+</div>
+ 
+### 特性
+
+* 48+ 个经过有赞线上业务检验的组件
+* 单元测试覆盖率超过 90%
+* 完善的文档和示例
+* 支持 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import)
+* 支持 TypeScript
+* 支持 SSR
+
+### 快速上手
+
+请参考 [快速上手](https://www.youzanyun.com/zanui/vant#/zh-CN/component/quickstart).
+
+### 贡献代码
+
+修改代码请阅读我们的 [开发指南](https://github.com/youzan/vant/blob/dev/.github/CONTRIBUTING.zh-CN.md)。
+
+使用过程中发现任何问题都可以提 [Issue](https://github.com/youzan/vant/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/youzan/vant/pulls)。
+
+### 浏览器支持
+
+现代浏览器以及 Android 4.0+, iOS 6+.
+
+### 链接
+
+* [更新日志](https://www.youzanyun.com/zanui/vant#/zh-CN/component/changelog)
+* [微信小程序组件库](https://github.com/youzan/zanui-weapp)
+* [vant-demo](https://github.com/youzan/vant-demo)
+* [vue-cli-template-vant](https://github.com/youzan/vue-cli-template-vant)
+
+### 开源协议
+
+本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89) 协议，请自由地享受和参与开源。
--- a/docs/markdown/zh-CN/quickstart.md
+++ b/docs/markdown/zh-CN/quickstart.md
@@ -1,6 +1,4 @@
-## Vant
-
-基于`Vue 2.0`的 Mobile 组件库
+## 快速上手

 ### 安装

--- a/docs/src/DocsApp.vue
+++ b/docs/src/DocsApp.vue
@@ -39,3 +39,33 @@ export default {
  }
 };
 </script>
+
+<style lang="postcss">
+.van-doc-intro {
+  text-align: center;
+  font-family: "Dosis", "Source Sans Pro", "Helvetica Neue", Arial, sans-serif;
+
+  &__youzan {
+    width: 32px;
+    height: 32px;
+    display: block;
+    margin: 25px 0 0;
+  }
+
+  &__logo {
+    width: 120px;
+    height: 120px;
+  }
+
+  h2 {
+    font-size: 32px;
+    line-height: 60px;
+    font-weight: normal;
+  }
+
+  p {
+    font-size: 15px;
+    color: #455a64;
+  }
+}
+</style>
--- a/docs/src/doc.config.js
+++ b/docs/src/doc.config.js
@@ -32,6 +32,11 @@ module.exports = {
        groups: [
          {
            list: [
+              {
+                path: '/intro',
+                title: '介绍',
+                noExample: true
+              },
              {
                path: '/quickstart',
                title: '快速上手',
@@ -315,6 +320,11 @@ module.exports = {
        groups: [
          {
            list: [
+              {
+                path: '/intro',
+                title: 'Introduction',
+                noExample: true
+              },
              {
                path: '/quickstart',
                title: 'Getting Started',
--- a/docs/src/router.config.js
+++ b/docs/src/router.config.js
@@ -22,7 +22,7 @@ const registerRoute = (isExample) => {
    } else {
      route.push({
        path: `/${lang}`,
-        redirect: `/${lang}/component/quickstart`
+        redirect: `/${lang}/component/intro`
      });
    }