mirror of
https://github.com/youzan/vant.git
synced 2025-10-20 02:31:21 +00:00
[Improvement] Reorganize document (#1066)
This commit is contained in:
neverland
@@ -24,18 +24,15 @@ module.exports = {
|
||||
list: [
|
||||
{
|
||||
path: '/intro',
|
||||
title: '介绍',
|
||||
noExample: true
|
||||
title: '介绍'
|
||||
},
|
||||
{
|
||||
path: '/quickstart',
|
||||
title: '快速上手',
|
||||
noExample: true
|
||||
title: '快速上手'
|
||||
},
|
||||
{
|
||||
path: '/changelog',
|
||||
title: '更新日志',
|
||||
noExample: true
|
||||
title: '更新日志'
|
||||
},
|
||||
{
|
||||
path: '/vant-css',
|
||||
@@ -43,19 +40,15 @@ module.exports = {
|
||||
},
|
||||
{
|
||||
path: '/theme',
|
||||
title: '定制主题',
|
||||
noExample: true
|
||||
title: '定制主题'
|
||||
},
|
||||
{
|
||||
path: '/demo',
|
||||
title: '示例页面',
|
||||
noDocument: true,
|
||||
noExample: true
|
||||
title: '示例页面'
|
||||
},
|
||||
{
|
||||
path: '/i18n',
|
||||
title: '国际化',
|
||||
noExample: true
|
||||
path: '/locale',
|
||||
title: '国际化'
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -326,18 +319,15 @@ module.exports = {
|
||||
list: [
|
||||
{
|
||||
path: '/intro',
|
||||
title: 'Introduction',
|
||||
noExample: true
|
||||
title: 'Introduction'
|
||||
},
|
||||
{
|
||||
path: '/quickstart',
|
||||
title: 'Quickstart',
|
||||
noExample: true
|
||||
title: 'Quickstart'
|
||||
},
|
||||
{
|
||||
path: '/changelog',
|
||||
title: 'Changelog',
|
||||
noExample: true
|
||||
title: 'Changelog'
|
||||
},
|
||||
{
|
||||
path: '/vant-css',
|
||||
@@ -345,19 +335,15 @@ module.exports = {
|
||||
},
|
||||
{
|
||||
path: '/theme',
|
||||
title: 'Custom Theme',
|
||||
noExample: true
|
||||
title: 'Custom Theme'
|
||||
},
|
||||
{
|
||||
path: '/demo',
|
||||
title: 'Demo pages',
|
||||
noDocument: true,
|
||||
noExample: true
|
||||
title: 'Demo pages'
|
||||
},
|
||||
{
|
||||
path: '/i18n',
|
||||
title: 'Internationalization',
|
||||
noExample: true
|
||||
path: '/locale',
|
||||
title: 'Internationalization'
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
133
docs/src/docs-entry.js
Normal file
133
docs/src/docs-entry.js
Normal file
@@ -0,0 +1,133 @@
|
||||
// This file is auto gererated by build/bin/build-entry.js
|
||||
import progress from 'nprogress';
|
||||
|
||||
function wrapper(component) {
|
||||
return function(r) {
|
||||
progress.start();
|
||||
component(r).then(() => {
|
||||
progress.done();
|
||||
}).catch(() => {
|
||||
progress.done();
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
export default {
|
||||
'changelog.en-US': wrapper(r => require.ensure([], () => r(require('../markdown/changelog.en-US.md')), 'changelog.en-US')),
|
||||
'changelog.generated': wrapper(r => require.ensure([], () => r(require('../markdown/changelog.generated.md')), 'changelog.generated')),
|
||||
'changelog.zh-CN': wrapper(r => require.ensure([], () => r(require('../markdown/changelog.zh-CN.md')), 'changelog.zh-CN')),
|
||||
'intro.en-US': wrapper(r => require.ensure([], () => r(require('../markdown/intro.en-US.md')), 'intro.en-US')),
|
||||
'intro.zh-CN': wrapper(r => require.ensure([], () => r(require('../markdown/intro.zh-CN.md')), 'intro.zh-CN')),
|
||||
'quickstart.en-US': wrapper(r => require.ensure([], () => r(require('../markdown/quickstart.en-US.md')), 'quickstart.en-US')),
|
||||
'quickstart.zh-CN': wrapper(r => require.ensure([], () => r(require('../markdown/quickstart.zh-CN.md')), 'quickstart.zh-CN')),
|
||||
'theme.en-US': wrapper(r => require.ensure([], () => r(require('../markdown/theme.en-US.md')), 'theme.en-US')),
|
||||
'theme.zh-CN': wrapper(r => require.ensure([], () => r(require('../markdown/theme.zh-CN.md')), 'theme.zh-CN')),
|
||||
'actionsheet.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/actionsheet/en-US.md')), 'actionsheet.en-US')),
|
||||
'actionsheet.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/actionsheet/zh-CN.md')), 'actionsheet.zh-CN')),
|
||||
'address-edit.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/address-edit/en-US.md')), 'address-edit.en-US')),
|
||||
'address-edit.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/address-edit/zh-CN.md')), 'address-edit.zh-CN')),
|
||||
'address-list.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/address-list/en-US.md')), 'address-list.en-US')),
|
||||
'address-list.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/address-list/zh-CN.md')), 'address-list.zh-CN')),
|
||||
'area.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/area/en-US.md')), 'area.en-US')),
|
||||
'area.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/area/zh-CN.md')), 'area.zh-CN')),
|
||||
'badge.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/badge/en-US.md')), 'badge.en-US')),
|
||||
'badge.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/badge/zh-CN.md')), 'badge.zh-CN')),
|
||||
'button.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/button/en-US.md')), 'button.en-US')),
|
||||
'button.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/button/zh-CN.md')), 'button.zh-CN')),
|
||||
'card.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/card/en-US.md')), 'card.en-US')),
|
||||
'card.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/card/zh-CN.md')), 'card.zh-CN')),
|
||||
'cell.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/cell/en-US.md')), 'cell.en-US')),
|
||||
'cell.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/cell/zh-CN.md')), 'cell.zh-CN')),
|
||||
'cell-swipe.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/cell-swipe/en-US.md')), 'cell-swipe.en-US')),
|
||||
'cell-swipe.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/cell-swipe/zh-CN.md')), 'cell-swipe.zh-CN')),
|
||||
'checkbox.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/checkbox/en-US.md')), 'checkbox.en-US')),
|
||||
'checkbox.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/checkbox/zh-CN.md')), 'checkbox.zh-CN')),
|
||||
'circle.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/circle/en-US.md')), 'circle.en-US')),
|
||||
'circle.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/circle/zh-CN.md')), 'circle.zh-CN')),
|
||||
'col.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/col/en-US.md')), 'col.en-US')),
|
||||
'col.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/col/zh-CN.md')), 'col.zh-CN')),
|
||||
'collapse.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/collapse/en-US.md')), 'collapse.en-US')),
|
||||
'collapse.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/collapse/zh-CN.md')), 'collapse.zh-CN')),
|
||||
'contact-card.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/contact-card/en-US.md')), 'contact-card.en-US')),
|
||||
'contact-card.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/contact-card/zh-CN.md')), 'contact-card.zh-CN')),
|
||||
'coupon-list.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/coupon-list/en-US.md')), 'coupon-list.en-US')),
|
||||
'coupon-list.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/coupon-list/zh-CN.md')), 'coupon-list.zh-CN')),
|
||||
'datetime-picker.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/datetime-picker/en-US.md')), 'datetime-picker.en-US')),
|
||||
'datetime-picker.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/datetime-picker/zh-CN.md')), 'datetime-picker.zh-CN')),
|
||||
'dialog.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/dialog/en-US.md')), 'dialog.en-US')),
|
||||
'dialog.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/dialog/zh-CN.md')), 'dialog.zh-CN')),
|
||||
'field.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/field/en-US.md')), 'field.en-US')),
|
||||
'field.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/field/zh-CN.md')), 'field.zh-CN')),
|
||||
'goods-action.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/goods-action/en-US.md')), 'goods-action.en-US')),
|
||||
'goods-action.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/goods-action/zh-CN.md')), 'goods-action.zh-CN')),
|
||||
'icon.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/icon/en-US.md')), 'icon.en-US')),
|
||||
'icon.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/icon/zh-CN.md')), 'icon.zh-CN')),
|
||||
'image-preview.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/image-preview/en-US.md')), 'image-preview.en-US')),
|
||||
'image-preview.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/image-preview/zh-CN.md')), 'image-preview.zh-CN')),
|
||||
'lazyload.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/lazyload/en-US.md')), 'lazyload.en-US')),
|
||||
'lazyload.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/lazyload/zh-CN.md')), 'lazyload.zh-CN')),
|
||||
'list.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/list/en-US.md')), 'list.en-US')),
|
||||
'list.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/list/zh-CN.md')), 'list.zh-CN')),
|
||||
'loading.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/loading/en-US.md')), 'loading.en-US')),
|
||||
'loading.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/loading/zh-CN.md')), 'loading.zh-CN')),
|
||||
'locale.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/locale/en-US.md')), 'locale.en-US')),
|
||||
'locale.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/locale/zh-CN.md')), 'locale.zh-CN')),
|
||||
'nav-bar.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/nav-bar/en-US.md')), 'nav-bar.en-US')),
|
||||
'nav-bar.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/nav-bar/zh-CN.md')), 'nav-bar.zh-CN')),
|
||||
'notice-bar.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/notice-bar/en-US.md')), 'notice-bar.en-US')),
|
||||
'notice-bar.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/notice-bar/zh-CN.md')), 'notice-bar.zh-CN')),
|
||||
'number-keyboard.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/number-keyboard/en-US.md')), 'number-keyboard.en-US')),
|
||||
'number-keyboard.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/number-keyboard/zh-CN.md')), 'number-keyboard.zh-CN')),
|
||||
'pagination.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/pagination/en-US.md')), 'pagination.en-US')),
|
||||
'pagination.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/pagination/zh-CN.md')), 'pagination.zh-CN')),
|
||||
'panel.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/panel/en-US.md')), 'panel.en-US')),
|
||||
'panel.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/panel/zh-CN.md')), 'panel.zh-CN')),
|
||||
'password-input.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/password-input/en-US.md')), 'password-input.en-US')),
|
||||
'password-input.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/password-input/zh-CN.md')), 'password-input.zh-CN')),
|
||||
'picker.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/picker/en-US.md')), 'picker.en-US')),
|
||||
'picker.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/picker/zh-CN.md')), 'picker.zh-CN')),
|
||||
'popup.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/popup/en-US.md')), 'popup.en-US')),
|
||||
'popup.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/popup/zh-CN.md')), 'popup.zh-CN')),
|
||||
'progress.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/progress/en-US.md')), 'progress.en-US')),
|
||||
'progress.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/progress/zh-CN.md')), 'progress.zh-CN')),
|
||||
'pull-refresh.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/pull-refresh/en-US.md')), 'pull-refresh.en-US')),
|
||||
'pull-refresh.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/pull-refresh/zh-CN.md')), 'pull-refresh.zh-CN')),
|
||||
'radio.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/radio/en-US.md')), 'radio.en-US')),
|
||||
'radio.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/radio/zh-CN.md')), 'radio.zh-CN')),
|
||||
'rate.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/rate/en-US.md')), 'rate.en-US')),
|
||||
'rate.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/rate/zh-CN.md')), 'rate.zh-CN')),
|
||||
'search.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/search/en-US.md')), 'search.en-US')),
|
||||
'search.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/search/zh-CN.md')), 'search.zh-CN')),
|
||||
'sku.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/sku/en-US.md')), 'sku.en-US')),
|
||||
'sku.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/sku/zh-CN.md')), 'sku.zh-CN')),
|
||||
'slider.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/slider/en-US.md')), 'slider.en-US')),
|
||||
'slider.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/slider/zh-CN.md')), 'slider.zh-CN')),
|
||||
'stepper.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/stepper/en-US.md')), 'stepper.en-US')),
|
||||
'stepper.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/stepper/zh-CN.md')), 'stepper.zh-CN')),
|
||||
'steps.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/steps/en-US.md')), 'steps.en-US')),
|
||||
'steps.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/steps/zh-CN.md')), 'steps.zh-CN')),
|
||||
'submit-bar.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/submit-bar/en-US.md')), 'submit-bar.en-US')),
|
||||
'submit-bar.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/submit-bar/zh-CN.md')), 'submit-bar.zh-CN')),
|
||||
'swipe.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/swipe/en-US.md')), 'swipe.en-US')),
|
||||
'swipe.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/swipe/zh-CN.md')), 'swipe.zh-CN')),
|
||||
'switch.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/switch/en-US.md')), 'switch.en-US')),
|
||||
'switch.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/switch/zh-CN.md')), 'switch.zh-CN')),
|
||||
'switch-cell.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/switch-cell/en-US.md')), 'switch-cell.en-US')),
|
||||
'switch-cell.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/switch-cell/zh-CN.md')), 'switch-cell.zh-CN')),
|
||||
'tab.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/tab/en-US.md')), 'tab.en-US')),
|
||||
'tab.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/tab/zh-CN.md')), 'tab.zh-CN')),
|
||||
'tabbar.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/tabbar/en-US.md')), 'tabbar.en-US')),
|
||||
'tabbar.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/tabbar/zh-CN.md')), 'tabbar.zh-CN')),
|
||||
'tag.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/tag/en-US.md')), 'tag.en-US')),
|
||||
'tag.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/tag/zh-CN.md')), 'tag.zh-CN')),
|
||||
'toast.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/toast/en-US.md')), 'toast.en-US')),
|
||||
'toast.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/toast/zh-CN.md')), 'toast.zh-CN')),
|
||||
'tree-select.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/tree-select/en-US.md')), 'tree-select.en-US')),
|
||||
'tree-select.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/tree-select/zh-CN.md')), 'tree-select.zh-CN')),
|
||||
'uploader.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/uploader/en-US.md')), 'uploader.en-US')),
|
||||
'uploader.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/uploader/zh-CN.md')), 'uploader.zh-CN')),
|
||||
'vant-css.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/vant-css/en-US.md')), 'vant-css.en-US')),
|
||||
'vant-css.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/vant-css/zh-CN.md')), 'vant-css.zh-CN')),
|
||||
'waterfall.en-US': wrapper(r => require.ensure([], () => r(require('../../packages/waterfall/en-US.md')), 'waterfall.en-US')),
|
||||
'waterfall.zh-CN': wrapper(r => require.ensure([], () => r(require('../../packages/waterfall/zh-CN.md')), 'waterfall.zh-CN'))
|
||||
};
|
||||
@@ -1,19 +1,19 @@
|
||||
import Vue from 'vue';
|
||||
import docConfig from './doc.config';
|
||||
import DemoList from './components/DemoList';
|
||||
import componentDocs from '../markdown';
|
||||
import componentDocs from './docs-entry';
|
||||
import componentDemos from './demo-entry';
|
||||
import DemoPages from './components/DemoPages';
|
||||
import Vue from 'vue';
|
||||
import './utils/iframe-router';
|
||||
|
||||
const registerRoute = (isExample) => {
|
||||
const registerRoute = (isDemo) => {
|
||||
const route = [{
|
||||
path: '*',
|
||||
redirect: to => `/${Vue.prototype.$vantLang}/`
|
||||
}];
|
||||
|
||||
Object.keys(docConfig).forEach((lang, index) => {
|
||||
if (isExample) {
|
||||
if (isDemo) {
|
||||
route.push({
|
||||
path: `/${lang}`,
|
||||
component: DemoList,
|
||||
@@ -38,25 +38,25 @@ const registerRoute = (isExample) => {
|
||||
});
|
||||
|
||||
function addRoute(page, lang) {
|
||||
if (isExample && page.noExample) {
|
||||
return;
|
||||
}
|
||||
|
||||
const { path } = page;
|
||||
let { path } = page;
|
||||
if (path) {
|
||||
const name = lang + '/' + path.replace('/', '');
|
||||
let component;
|
||||
path = path.replace('/', '');
|
||||
|
||||
if (path === '/demo') {
|
||||
let component;
|
||||
if (path === 'demo') {
|
||||
component = DemoPages;
|
||||
} else {
|
||||
component = isExample ? componentDemos[path.replace('/', '')] : componentDocs[name];
|
||||
component = isDemo ? componentDemos[path] : componentDocs[`${path}.${lang}`];
|
||||
}
|
||||
|
||||
if (!component) {
|
||||
return;
|
||||
}
|
||||
|
||||
route.push({
|
||||
name,
|
||||
name: lang + '/' + path,
|
||||
component,
|
||||
path: `/${lang}${path}`,
|
||||
path: `/${lang}/${path}`,
|
||||
meta: {
|
||||
lang,
|
||||
name: page.title
|
||||
|
||||
Reference in New Issue
Block a user