404
5 | 6 |{{ getMsg() }}7 | 8 |
{{ getMsg() }}7 | 8 |
Blablabla...
6 | `; 7 | 8 | exports[`markdown page should extract headers by config 1`] = ` 9 | Array [ 10 | Object { 11 | "level": 1, 12 | "slug": "alpha", 13 | "title": "Alpha", 14 | }, 15 | Object { 16 | "level": 2, 17 | "slug": "h2", 18 | "title": "h2", 19 | }, 20 | ] 21 | `; 22 | 23 | exports[`markdown page should extract level 2 and 3 headers by default 1`] = ` 24 | Array [ 25 | Object { 26 | "level": 2, 27 | "slug": "h2", 28 | "title": "h2", 29 | }, 30 | Object { 31 | "level": 3, 32 | "slug": "h3", 33 | "title": "h3", 34 | }, 35 | ] 36 | `; 37 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-config/.vuepress/config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | title: 'Hello VuePress', 3 | description: '# Hello, VuePress!', 4 | dest: 'vuepress', 5 | base: 'vuepress', 6 | head: [ 7 | ['link', { rel: 'icon', href: '/logo.png' }] 8 | ] 9 | } 10 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-config/README.md: -------------------------------------------------------------------------------- 1 | # Hello, VuePress! 2 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-dep-theme-without-index/.vuepress/config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | title: 'Hello VuePress', 3 | description: '# Hello, VuePress!', 4 | theme: 'vuepress-theme-without-index' 5 | } 6 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-dep-theme-without-index/README.md: -------------------------------------------------------------------------------- 1 | # Hello, VuePress! 2 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-i18n/.vuepress/config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | dest: 'vuepress', 3 | locales: { 4 | '/': { 5 | lang: 'en-US', 6 | title: 'VuePress', 7 | description: 'Vue-powered Static Site Generator' 8 | }, 9 | '/zh/': { 10 | lang: 'zh-CN', 11 | title: 'VuePress', 12 | description: 'Vue 驱动的静态网站生成器' 13 | } 14 | }, 15 | themeConfig: { 16 | repo: 'vuejs/vuepress', 17 | editLinks: true, 18 | docsDir: 'docs', 19 | locales: { 20 | '/': { 21 | label: 'English', 22 | selectText: 'Languages', 23 | editLinkText: 'Edit this page on GitHub', 24 | lastUpdated: 'Last Updated' 25 | }, 26 | '/zh/': { 27 | label: '简体中文', 28 | selectText: '选择语言', 29 | editLinkText: '在 GitHub 上编辑此页', 30 | lastUpdated: '上次更新' 31 | } 32 | } 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-i18n/README.md: -------------------------------------------------------------------------------- 1 | # Hello, VuePress! 2 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-i18n/zh/README.md: -------------------------------------------------------------------------------- 1 | # 你好, VuePress! 2 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-local-theme/.vuepress/config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | title: 'Hello VuePress', 3 | description: '# Hello, VuePress!' 4 | } 5 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-local-theme/.vuepress/theme/Layout.vue: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vuejs/vuepress/9fb4bb00925d9409e6732118e996411c6a82c85d/packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-local-theme/.vuepress/theme/Layout.vue -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-local-theme/README.md: -------------------------------------------------------------------------------- 1 | # Hello, VuePress! 2 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-patterns/.vuepress/config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | title: 'Hello VuePress', 3 | description: '# Hello, VuePress!', 4 | dest: 'vuepress', 5 | base: 'vuepress', 6 | patterns: ['**/*.md', '**/*.vue', '!**/deploy.*'], 7 | head: [ 8 | ['link', { rel: 'icon', href: '/logo.png' }] 9 | ] 10 | } 11 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs-patterns/README.md: -------------------------------------------------------------------------------- 1 | # Hello, VuePress! 2 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs/2020-01-01-date.md: -------------------------------------------------------------------------------- 1 | # Date 2 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs/README.md: -------------------------------------------------------------------------------- 1 | # Home 2 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs/alpha.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: VuePress Alpha 3 | --- 4 | 5 | # Alpha 6 | 7 | ## h2 8 | 9 | ### h3 10 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/fixtures/docs/excerpt.md: -------------------------------------------------------------------------------- 1 | # Excerpt 2 | 3 | Blablabla... 4 | 5 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/prepare/util.js: -------------------------------------------------------------------------------- 1 | const { fs, path } = require('@vuepress/shared-utils') 2 | const createMarkdown = require('../../../../../markdown/index') 3 | 4 | const docsBaseDir = path.resolve(__dirname, 'fixtures/docs') 5 | 6 | function getDocument (relative) { 7 | return { 8 | filePath: path.join(docsBaseDir, relative), 9 | relative 10 | } 11 | } 12 | 13 | const getMarkdown = createMarkdown 14 | 15 | const readFile = async filePath => await fs.readFile(filePath, 'utf-8') 16 | 17 | module.exports = { 18 | getMarkdown, 19 | getDocument, 20 | readFile 21 | } 22 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/theme-api/fixtures/theme/Layout.vue: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vuejs/vuepress/9fb4bb00925d9409e6732118e996411c6a82c85d/packages/@vuepress/core/lib/node/__tests__/theme-api/fixtures/theme/Layout.vue -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/theme-api/fixtures/theme/components/Home.vue: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vuejs/vuepress/9fb4bb00925d9409e6732118e996411c6a82c85d/packages/@vuepress/core/lib/node/__tests__/theme-api/fixtures/theme/components/Home.vue -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/__tests__/theme-api/index.spec.js: -------------------------------------------------------------------------------- 1 | jest.mock('vuepress-theme-parent') 2 | jest.mock('vuepress-theme-child') 3 | 4 | import ThemeAPI from '../../theme-api' 5 | import { resolve } from 'path' 6 | 7 | const theme = { 8 | path: resolve(process.cwd(), '__mocks__/vuepress-theme-child'), 9 | name: 'vuepress-theme-child', 10 | shortcut: 'child', 11 | entryFile: require('vuepress-theme-child') 12 | } 13 | 14 | const parent = { 15 | path: resolve(process.cwd(), '__mocks__/vuepress-theme-parent'), 16 | name: 'vuepress-theme-parent', 17 | shortcut: 'parent', 18 | entryFile: {} 19 | } 20 | 21 | describe('ThemeAPI', () => { 22 | test('extend', async () => { 23 | const themeAPI = new ThemeAPI(theme, parent) 24 | console.log(themeAPI.theme.entry) 25 | }) 26 | // loadTheme('vuepress-theme-child') 27 | }) 28 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/createMarkdown.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | /** 4 | * Module dependencies. 5 | */ 6 | 7 | const createMarkdown = require('@vuepress/markdown') 8 | 9 | /** 10 | * Expose createMarkdown. 11 | */ 12 | 13 | module.exports = function (ctx) { 14 | const { markdown: markdownConfig = {}} = ctx.siteConfig 15 | const { chainMarkdown, extendMarkdown } = markdownConfig 16 | 17 | const beforeInstantiate = config => { 18 | chainMarkdown && chainMarkdown(config) 19 | ctx.pluginAPI.applySyncOption('chainMarkdown', config) 20 | } 21 | 22 | const afterInstantiate = md => { 23 | extendMarkdown && extendMarkdown(md) 24 | ctx.pluginAPI.applySyncOption('extendMarkdown', md) 25 | } 26 | 27 | return createMarkdown( 28 | Object.assign(markdownConfig, { 29 | beforeInstantiate, 30 | afterInstantiate 31 | }) 32 | ) 33 | } 34 | -------------------------------------------------------------------------------- /packages/@vuepress/core/lib/node/docs.fallback/.vuepress/theme/Layout.vue: -------------------------------------------------------------------------------- 1 | 2 |new Vue()
5 | new Vue()
20 | new Vue()
7 | new Vue()
17 | new Vue()
27 | '),
10 | rawCode.indexOf('')
11 | )
12 |
13 | const lines = code.split('\n')
14 | const lineNumbersCode = [...Array(lines.length - 1)]
15 | .map((line, index) => `${index + 1}.... 2 | // 3 | // If your plugin was chained before preWrapper, you can add additional element directly. 4 | // If your plugin was chained after preWrapper, you can use these slots: 5 | // 1. 6 | // 2. 7 | // 3. 8 | // 4. 9 | 10 | module.exports = md => { 11 | const wrap = (wrapped) => (...args) => { 12 | const [tokens, idx] = args 13 | const token = tokens[idx] 14 | const rawCode = wrapped(...args) 15 | const tokenInfo = token.info.trim().replace(/\"/g, '\'') 16 | return `
(markdown token: '`') tag.
16 |
17 | const removeMarkdownTokens = (str: string): string => String(str)
18 | .replace(/(\[(.[^\]]+)\]\((.[^)]+)\))/g, '$2') // []()
19 | .replace(/(`|\*{1,3}|_)(.*?[^\\])\1/g, '$2') // `{t}` | *{t}* | **{t}** | ***{t}*** | _{t}_
20 | .replace(/(\\)(\*|_|`|\!|<)/g, '$2') // remove escape char '\'
21 |
22 | const trim = (str: string): string => str.trim()
23 |
24 | // Unescape html, parse emojis and remove some md tokens.
25 | const parseHeaders: (v: string) => string = compose(
26 | unescapeHtml,
27 | parseEmojis,
28 | removeMarkdownTokens,
29 | trim
30 | )
31 |
32 | export = parseHeaders
33 |
--------------------------------------------------------------------------------
/packages/@vuepress/shared-utils/src/parseVueFrontmatter.ts:
--------------------------------------------------------------------------------
1 | import { parse as _parse } from '@vue/component-compiler-utils'
2 | import parseFrontmatter from './parseFrontmatter'
3 |
4 | export function parseStrippedFrontmatter (src: string) {
5 | src = `---\n${src}\n---`
6 | return parseFrontmatter(src)
7 | }
8 |
9 | export function parse (src: string) {
10 | const output = _parse({
11 | source: src,
12 | compiler: require('vue-template-compiler'),
13 | needMap: false
14 | })
15 | const find = output.customBlocks.find(block => block.type === 'frontmatter')
16 | const frontmatterRaw = find && find.content
17 | if (frontmatterRaw) {
18 | return parseStrippedFrontmatter(frontmatterRaw)
19 | }
20 | return {}
21 | }
22 |
--------------------------------------------------------------------------------
/packages/@vuepress/shared-utils/src/performance.ts:
--------------------------------------------------------------------------------
1 | import os from 'os'
2 |
3 | class Performance {
4 | private _totalMemory: number
5 | private _startFreeMemory: number
6 | private _endFreeMemory: number
7 | private _startTime: number
8 | private _endTime: number
9 |
10 | constructor () {
11 | this._totalMemory = os.totalmem()
12 | }
13 |
14 | start () {
15 | this._startTime = Date.now()
16 | this._startFreeMemory = os.freemem()
17 | }
18 |
19 | stop () {
20 | this._endTime = Date.now()
21 | this._endFreeMemory = os.freemem()
22 | return {
23 | duration: this._endTime - this._startTime,
24 | memoryDiff: this._endFreeMemory - this._startFreeMemory
25 | }
26 | }
27 | }
28 |
29 | export = new Performance()
30 |
--------------------------------------------------------------------------------
/packages/@vuepress/shared-utils/src/removeNonCodeWrappedHTML.ts:
--------------------------------------------------------------------------------
1 | // This method remove the raw HTML but reserve the HTML wrapped by ``.
2 | // e.g.
3 | // Input: " b", Output: "b"
4 | // Input: "`` b", Output: "`` b"
5 | export = function removeNonCodeWrappedHTML (str: string): string {
6 | return String(str).replace(/(^|[^><`\\])<.*>([^><`]|$)/g, '$1$2')
7 | }
8 |
--------------------------------------------------------------------------------
/packages/@vuepress/shared-utils/src/slugify.ts:
--------------------------------------------------------------------------------
1 | // string.js slugify drops non ascii chars so we have to
2 | // use a custom implementation here
3 |
4 | // eslint-disable-next-line no-control-regex
5 | const rControl = /[\u0000-\u001f]/g
6 | const rSpecial = /[\s~`!@#$%^&*()\-_+=[\]{}|\\;:"'“”‘’–—<>,.?/]+/g
7 | const rCombining = /[\u0300-\u036F]/g
8 |
9 | export = function slugify (str: string): string {
10 | // Split accented characters into components
11 | return str.normalize('NFKD')
12 | // Remove accents
13 | .replace(rCombining, '')
14 | // Remove control characters
15 | .replace(rControl, '')
16 | // Replace special characters
17 | .replace(rSpecial, '-')
18 | // Remove continuous separators
19 | .replace(/\-{2,}/g, '-')
20 | // Remove prefixing and trailing separators
21 | .replace(/^\-+|\-+$/g, '')
22 | // ensure it doesn't start with a number (#121)
23 | .replace(/^(\d)/, '_$1')
24 | // lowercase
25 | .toLowerCase()
26 | }
27 |
--------------------------------------------------------------------------------
/packages/@vuepress/shared-utils/src/sort.ts:
--------------------------------------------------------------------------------
1 | export = function sort (arr: number[]) {
2 | return arr.sort((a, b) => {
3 | if (a < b) return -1
4 | if (a > b) return 1
5 | return 0
6 | })
7 | }
8 |
--------------------------------------------------------------------------------
/packages/@vuepress/shared-utils/src/toAbsolutePath.ts:
--------------------------------------------------------------------------------
1 | import path from 'upath'
2 |
3 | /**
4 | * Normalize path request to absolute path.
5 | */
6 |
7 | export = function toAbsolutePath (raw: string, cwd: string = process.cwd()) {
8 | if (path.isAbsolute(raw)) {
9 | return raw
10 | }
11 | return path.resolve(cwd, raw)
12 | }
13 |
--------------------------------------------------------------------------------
/packages/@vuepress/shared-utils/src/tryChain.ts:
--------------------------------------------------------------------------------
1 | type Provider = (arg: T) => U
2 | type Resolver = (Provider | boolean)[] | Provider
3 |
4 | export = function tryChain (resolvers: Array>, arg: T): U | void {
5 | let response: U
6 |
7 | for (let resolver of resolvers) {
8 | if (!Array.isArray(resolver)) {
9 | resolver = [resolver, true]
10 | }
11 | const [provider, condition] = resolver
12 | if (!condition) {
13 | continue
14 | }
15 | try {
16 | response = (provider as Provider)(arg)
17 | return response
18 | } catch (e) {
19 | }
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/packages/@vuepress/shared-utils/src/unescapeHtml.ts:
--------------------------------------------------------------------------------
1 | export = (html: string): string => String(html)
2 | .replace(/"/g, '"')
3 | .replace(/'/g, '\'')
4 | .replace(/:/g, ':')
5 | .replace(/</g, '<')
6 | .replace(/>/g, '>')
7 |
8 |
--------------------------------------------------------------------------------
/packages/@vuepress/shared-utils/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../../tsconfig.json",
3 | "compilerOptions": {
4 | "outDir": "./lib",
5 | "declarationDir": "types"
6 | },
7 | "include": [
8 | "./src"
9 | ]
10 | }
11 |
--------------------------------------------------------------------------------
/packages/@vuepress/test-utils/.npmignore:
--------------------------------------------------------------------------------
1 | __tests__
2 | __mocks__
3 | .temp
4 |
--------------------------------------------------------------------------------
/packages/@vuepress/test-utils/README.md:
--------------------------------------------------------------------------------
1 | # @vuepress/test-utils
2 |
3 | > test-utils for VuePress
4 |
--------------------------------------------------------------------------------
/packages/@vuepress/test-utils/client/createLocalVue.js:
--------------------------------------------------------------------------------
1 | import Router from 'vue-router'
2 | import VuePress from '@vuepress/core/lib/client/plugins/VuePress'
3 | import dataMixin from '@vuepress/core/lib/client/dataMixin'
4 | import { createLocalVue } from '@vue/test-utils'
5 |
6 | import mockComponent from './mockComponent'
7 | import siteData from './siteData'
8 | import ClientComputedMixin from '@vuepress/core/lib/node/ClientComputedMixin'
9 |
10 | module.exports = function () {
11 | const localVue = createLocalVue()
12 | localVue.use(Router)
13 | localVue.use(VuePress)
14 |
15 | // register global component
16 | localVue.component('OutboundLink', mockComponent('outbound-link'))
17 | localVue.component(siteData.pages[0].key, mockComponent('page-component'))
18 | localVue.mixin(dataMixin(ClientComputedMixin, siteData, localVue))
19 | return localVue
20 | }
21 |
--------------------------------------------------------------------------------
/packages/@vuepress/test-utils/client/index.js:
--------------------------------------------------------------------------------
1 | import createLocalVue from './createLocalVue'
2 | import mockComponent from './mockComponent'
3 |
4 | export {
5 | createLocalVue,
6 | mockComponent
7 | }
8 |
--------------------------------------------------------------------------------
/packages/@vuepress/test-utils/client/mockComponent.js:
--------------------------------------------------------------------------------
1 | const Component = {
2 | props: ['name'],
3 | render (h) {
4 | return h('p', {
5 | class: ['component', this.name]
6 | }, this.name)
7 | }
8 | }
9 |
10 | // When the child component is a pure presentation component,
11 | // we want to be able to display a sub-component with minimal info,
12 | // rather than stubbing it directly.
13 | export default function mockComponent (name) {
14 | return {
15 | render (h) {
16 | return h(Component, { props: { name }})
17 | }
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/packages/@vuepress/test-utils/client/siteData.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable */
2 |
3 | export default {
4 | "title": "VuePress",
5 | "description": "",
6 | "base": "/",
7 | "pages": [
8 | {
9 | "title": "Hello, VuePress!",
10 | "frontmatter": {},
11 | "key": "v-37b29011bd265",
12 | "path": "/",
13 | "regularPath": "/"
14 | },
15 | {
16 | "title": "你好, VuePress!",
17 | "frontmatter": {},
18 | "key": "v-6a0244c805bde",
19 | "path": "/zh/",
20 | "regularPath": "/zh/"
21 | }
22 | ],
23 | "themeConfig": {
24 | "repo": "vuejs/vuepress",
25 | "editLinks": true,
26 | "docsDir": "docs",
27 | "locales": {
28 | "/": {
29 | "label": "English",
30 | "selectText": "Languages",
31 | "editLinkText": "Edit this page on GitHub",
32 | "lastUpdated": "Last Updated"
33 | },
34 | "/zh/": {
35 | "label": "简体中文",
36 | "selectText": "选择语言",
37 | "editLinkText": "在 GitHub 上编辑此页",
38 | "lastUpdated": "上次更新"
39 | }
40 | }
41 | },
42 | "locales": {
43 | "/": {
44 | "lang": "en-US",
45 | "title": "VuePress",
46 | "description": "Vue-powered Static Site Generator",
47 | "path": "/"
48 | },
49 | "/zh/": {
50 | "lang": "zh-CN",
51 | "title": "VuePress",
52 | "description": "Vue 驱动的静态网站生成器",
53 | "path": "/zh/"
54 | }
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/packages/@vuepress/test-utils/fixtures/docs/.vuepress/theme/Layout.vue:
--------------------------------------------------------------------------------
1 |
2 | /$1'
20 | },
21 | transform: {
22 | '^.+\\.js$': '/node_modules/babel-jest',
23 | '.*\\.(vue)$': '/node_modules/vue-jest',
24 | '^.+\\.ts?$': '/node_modules/ts-jest'
25 | },
26 | snapshotSerializers: [
27 | '/node_modules/jest-serializer-vue'
28 | ]
29 | }
30 |
--------------------------------------------------------------------------------
/packages/@vuepress/test-utils/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@vuepress/test-utils",
3 | "version": "1.9.10",
4 | "description": "test-utils for vuepress",
5 | "keywords": [
6 | "documentation",
7 | "generator",
8 | "vue",
9 | "vuepress"
10 | ],
11 | "homepage": "https://github.com/vuejs/vuepress/blob/master/packages/@vuepress/test-utils#readme",
12 | "bugs": {
13 | "url": "https://github.com/vuejs/vuepress/issues"
14 | },
15 | "repository": {
16 | "type": "git",
17 | "url": "git+https://github.com/vuejs/vuepress.git",
18 | "directory": "packages/@vuepress/test-utils"
19 | },
20 | "license": "MIT",
21 | "author": "ULIVZ ",
22 | "main": "index.js",
23 | "dependencies": {
24 | "@babel/core": "^7.0.0",
25 | "@babel/preset-env": "^7.0.0",
26 | "@types/jest": "^24.0.9",
27 | "@vue/test-utils": "^1.0.0-beta.29",
28 | "@vuepress/core": "1.9.10",
29 | "@vuepress/shared-utils": "1.9.10",
30 | "babel-jest": "^24.7.1",
31 | "execa": "^1.0.0",
32 | "jest": "^24.7.1",
33 | "jest-serializer-vue": "^2.0.2",
34 | "ts-jest": "^24.0.2",
35 | "vue": "^2.6.10",
36 | "vue-jest": "^4.0.0-beta.1",
37 | "vue-template-compiler": "^2.6.10"
38 | },
39 | "publishConfig": {
40 | "access": "public"
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/.npmignore:
--------------------------------------------------------------------------------
1 | __tests__
2 | __mocks__
3 | .temp
4 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/README.md:
--------------------------------------------------------------------------------
1 | # @vuepress/theme-default
2 |
3 | > theme-default for VuePress
4 |
5 | ## Plugins
6 |
7 | The default theme has the following plugin built in:
8 |
9 | - [@vuepress/plugin-active-header-links](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-active-header-links)
10 | - [@vuepress/plugin-google-analytics](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-google-analytics)
11 | - [@vuepress/plugin-search](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-search)
12 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/__tests__/components/DropdownLink.spec.js:
--------------------------------------------------------------------------------
1 | import { mount, RouterLinkStub } from '@vue/test-utils'
2 | import DropdownLink from '../../components/DropdownLink.vue'
3 | import { createLocalVue } from '@vuepress/test-utils/client'
4 |
5 | describe('DropdownLink', () => {
6 | test('renders dropdown link.', () => {
7 | const item = {
8 | text: 'Learn More',
9 | ariaLabel: 'Learn More Select',
10 | items: [
11 | {
12 | text: 'Guide',
13 | link: '/guide/'
14 | },
15 | {
16 | text: 'Config Reference',
17 | link: '/config/'
18 | }
19 | ]
20 | }
21 | const wrapper = mount(DropdownLink, {
22 | localVue: createLocalVue(),
23 | stubs: {
24 | 'RouterLink': RouterLinkStub
25 | },
26 | propsData: { item }
27 | })
28 | expect(wrapper.html()).toMatchSnapshot()
29 | })
30 | })
31 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/__tests__/components/NavLink.spec.js:
--------------------------------------------------------------------------------
1 | import { mount, RouterLinkStub } from '@vue/test-utils'
2 | import { createLocalVue } from '@vuepress/test-utils/client'
3 | import NavLink from '../../components/NavLink.vue'
4 |
5 | describe('NavLink', () => {
6 | test('renders nav link with internal link', () => {
7 | const item = {
8 | link: '/',
9 | text: 'VuePress'
10 | }
11 | const wrapper = mount(NavLink, {
12 | localVue: createLocalVue(),
13 | stubs: {
14 | 'RouterLink': RouterLinkStub
15 | },
16 | propsData: { item }
17 | })
18 | expect(wrapper.html()).toMatchSnapshot()
19 | })
20 |
21 | test('renders nav link with external link', () => {
22 | const item = {
23 | link: 'http://vuejs.org/',
24 | text: 'Vue'
25 | }
26 | const wrapper = mount(NavLink, {
27 | localVue: createLocalVue(),
28 | propsData: { item }
29 | })
30 | expect(wrapper.html()).toMatchSnapshot()
31 | })
32 | })
33 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/__tests__/components/__snapshots__/DropdownLink.spec.js.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`DropdownLink renders dropdown link. 1`] = `
4 |
5 |
15 |
16 | `;
17 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/__tests__/components/__snapshots__/NavLink.spec.js.snap:
--------------------------------------------------------------------------------
1 | // Jest Snapshot v1, https://goo.gl/fbAQLP
2 |
3 | exports[`NavLink renders nav link with external link 1`] = `
4 |
5 | Vue
6 | outbound-link
7 | `;
8 |
9 | exports[`NavLink renders nav link with internal link 1`] = `
10 |
11 | VuePress
12 |
13 | `;
14 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/components/DropdownTransition.vue:
--------------------------------------------------------------------------------
1 |
2 |
8 |
10 |
11 |
12 |
28 |
29 |
34 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/components/Page.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
12 |
13 |
14 |
23 |
24 |
32 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/components/SidebarButton.vue:
--------------------------------------------------------------------------------
1 |
2 |
20 |
21 |
22 |
41 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/global-components/Badge.vue:
--------------------------------------------------------------------------------
1 |
25 |
26 |
45 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/global-components/CodeBlock.vue:
--------------------------------------------------------------------------------
1 |
2 |
6 | 404
5 |
6 | {{ getMsg() }}
7 |
8 |
9 | Take me home.
10 |
11 |
12 |
13 |
14 |
15 |
31 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/noopModule.js:
--------------------------------------------------------------------------------
1 | export default {}
2 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@vuepress/theme-default",
3 | "version": "1.9.10",
4 | "description": "Default theme for VuePress",
5 | "keywords": [
6 | "documentation",
7 | "generator",
8 | "vue",
9 | "vuepress"
10 | ],
11 | "homepage": "https://github.com/vuejs/vuepress/blob/master/packages/@vuepress/theme-default#readme",
12 | "bugs": {
13 | "url": "https://github.com/vuejs/vuepress/issues"
14 | },
15 | "repository": {
16 | "type": "git",
17 | "url": "git+https://github.com/vuejs/vuepress.git",
18 | "directory": "packages/@vuepress/theme-default"
19 | },
20 | "license": "MIT",
21 | "author": "Evan You",
22 | "maintainers": [
23 | {
24 | "name": "ULIVZ",
25 | "email": "chl814@foxmail.com"
26 | }
27 | ],
28 | "main": "index.js",
29 | "dependencies": {
30 | "@vuepress/plugin-active-header-links": "1.9.10",
31 | "@vuepress/plugin-nprogress": "1.9.10",
32 | "@vuepress/plugin-search": "1.9.10",
33 | "@vuepress/types": "1.9.10",
34 | "docsearch.js": "^2.5.2",
35 | "lodash": "^4.17.15",
36 | "stylus": "^0.54.8",
37 | "stylus-loader": "^3.0.2",
38 | "vuepress-plugin-container": "^2.0.2",
39 | "vuepress-plugin-smooth-scroll": "^0.0.3"
40 | },
41 | "publishConfig": {
42 | "access": "public"
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/styles/arrow.styl:
--------------------------------------------------------------------------------
1 | @require './config'
2 |
3 | .arrow
4 | display inline-block
5 | width 0
6 | height 0
7 | &.up
8 | border-left 4px solid transparent
9 | border-right 4px solid transparent
10 | border-bottom 6px solid $arrowBgColor
11 | &.down
12 | border-left 4px solid transparent
13 | border-right 4px solid transparent
14 | border-top 6px solid $arrowBgColor
15 | &.right
16 | border-top 4px solid transparent
17 | border-bottom 4px solid transparent
18 | border-left 6px solid $arrowBgColor
19 | &.left
20 | border-top 4px solid transparent
21 | border-bottom 4px solid transparent
22 | border-right 6px solid $arrowBgColor
23 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/styles/config.styl:
--------------------------------------------------------------------------------
1 | $contentClass = '.theme-default-content'
2 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/styles/custom-blocks.styl:
--------------------------------------------------------------------------------
1 | .custom-block
2 | .custom-block-title
3 | font-weight 600
4 | margin-bottom -0.4rem
5 | &.tip, &.warning, &.danger
6 | padding .1rem 1.5rem
7 | border-left-width .5rem
8 | border-left-style solid
9 | margin 1rem 0
10 | &.tip
11 | background-color #f3f5f7
12 | border-color #42b983
13 | &.warning
14 | background-color rgba(255,229,100,.3)
15 | border-color darken(#ffe564, 35%)
16 | color darken(#ffe564, 70%)
17 | .custom-block-title
18 | color darken(#ffe564, 50%)
19 | a
20 | color $textColor
21 | &.danger
22 | background-color #ffe6e6
23 | border-color darken(red, 20%)
24 | color darken(red, 70%)
25 | .custom-block-title
26 | color darken(red, 40%)
27 | a
28 | color $textColor
29 | &.details
30 | display block
31 | position relative
32 | border-radius 2px
33 | margin 1.6em 0
34 | padding 1.6em
35 | background-color #eee
36 | h4
37 | margin-top 0
38 | figure, p
39 | &:last-child
40 | margin-bottom 0
41 | padding-bottom 0
42 | summary
43 | outline none
44 | cursor pointer
45 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/styles/mobile.styl:
--------------------------------------------------------------------------------
1 | @require './config'
2 |
3 | $mobileSidebarWidth = $sidebarWidth * 0.82
4 |
5 | // narrow desktop / iPad
6 | @media (max-width: $MQNarrow)
7 | .sidebar
8 | font-size 15px
9 | width $mobileSidebarWidth
10 | .page
11 | padding-left $mobileSidebarWidth
12 |
13 | // wide mobile
14 | @media (max-width: $MQMobile)
15 | .sidebar
16 | top 0
17 | padding-top $navbarHeight
18 | transform translateX(-100%)
19 | transition transform .2s ease
20 | .page
21 | padding-left 0
22 | .theme-container
23 | &.sidebar-open
24 | .sidebar
25 | transform translateX(0)
26 | &.no-navbar
27 | .sidebar
28 | padding-top: 0
29 |
30 | // narrow mobile
31 | @media (max-width: $MQMobileNarrow)
32 | h1
33 | font-size 1.9rem
34 | {$contentClass}
35 | div[class*="language-"]
36 | margin 0.85rem -1.5rem
37 | border-radius 0
38 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/styles/toc.styl:
--------------------------------------------------------------------------------
1 | .table-of-contents
2 | .badge
3 | vertical-align middle
4 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-default/styles/wrapper.styl:
--------------------------------------------------------------------------------
1 | $wrapper
2 | max-width $contentWidth
3 | margin 0 auto
4 | padding 2rem 2.5rem
5 | @media (max-width: $MQNarrow)
6 | padding 2rem
7 | @media (max-width: $MQMobileNarrow)
8 | padding 1.5rem
9 |
10 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-vue/.npmignore:
--------------------------------------------------------------------------------
1 | __tests__
2 | __mocks__
--------------------------------------------------------------------------------
/packages/@vuepress/theme-vue/README.md:
--------------------------------------------------------------------------------
1 | # @vuepress/theme-vue
2 |
3 | > theme-vue for VuePress
4 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-vue/index.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | extend: '@vuepress/theme-default'
3 | }
4 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-vue/layouts/Layout.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
10 |
11 |
12 |
27 |
--------------------------------------------------------------------------------
/packages/@vuepress/theme-vue/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@vuepress/theme-vue",
3 | "version": "1.9.10",
4 | "description": "VuePress theme for official Vue projects",
5 | "keywords": [
6 | "documentation",
7 | "generator",
8 | "vue",
9 | "vuepress"
10 | ],
11 | "homepage": "https://github.com/vuejs/vuepress/blob/master/packages/@vuepress/theme-vue#readme",
12 | "bugs": {
13 | "url": "https://github.com/vuejs/vuepress/issues"
14 | },
15 | "repository": {
16 | "type": "git",
17 | "url": "git+https://github.com/vuejs/vuepress.git",
18 | "directory": "packages/@vuepress/theme-vue"
19 | },
20 | "license": "MIT",
21 | "author": "Evan You",
22 | "maintainers": [
23 | {
24 | "name": "ULIVZ",
25 | "email": "chl814@foxmail.com"
26 | }
27 | ],
28 | "main": "index.js",
29 | "dependencies": {
30 | "@vuepress/theme-default": "1.9.10"
31 | },
32 | "publishConfig": {
33 | "access": "public"
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/packages/@vuepress/types/index.d.ts:
--------------------------------------------------------------------------------
1 | import {
2 | UserConfig,
3 | ThemeConfig,
4 | PluginOptions,
5 | DefaultThemeConfig,
6 | Theme,
7 | Plugin
8 | } from "./src";
9 |
10 | export * from "./src";
11 |
12 | /**
13 | * A helper function to define VuePress config file.
14 | *
15 | * @see https://vuepress.vuejs.org/config/
16 | */
17 | export function defineConfig(config: UserConfig): void;
18 |
19 | /**
20 | * A helper function to define VuePress config file, for custom theme.
21 | *
22 | * @see https://vuepress.vuejs.org/config/
23 | */
24 | export function defineConfig4CustomTheme(
25 | config: UserConfig
26 | ): void;
27 |
28 | /**
29 | * A helper function to define VuePress theme entry file.
30 | *
31 | * @see https://vuepress.vuejs.org/theme/option-api.html
32 | */
33 | export function defineTheme(
34 | config: Theme
35 | ): void;
36 |
37 | /**
38 | * A helper function to define VuePress theme entry file.
39 | *
40 | * @see https://vuepress.vuejs.org/plugin/writing-a-plugin.html
41 | */
42 | export function definePlugin<
43 | T extends PluginOptions = PluginOptions,
44 | U extends ThemeConfig = ThemeConfig
45 | >(config: Plugin): void;
46 |
--------------------------------------------------------------------------------
/packages/@vuepress/types/index.js:
--------------------------------------------------------------------------------
1 | function define(config) {
2 | return config;
3 | }
4 | exports.defineConfig = define;
5 | exports.defineConfig4CustomTheme = define;
6 | exports.defineTheme = define;
7 | exports.definePlugin = define;
8 |
--------------------------------------------------------------------------------
/packages/@vuepress/types/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@vuepress/types",
3 | "version": "1.9.10",
4 | "description": "Types for VuePress",
5 | "keywords": [
6 | "documentation",
7 | "generator",
8 | "types",
9 | "vue",
10 | "vuepress"
11 | ],
12 | "homepage": "https://github.com/vuejs/vuepress/blob/master/packages/@vuepress/types#readme",
13 | "bugs": {
14 | "url": "https://github.com/vuejs/vuepress/issues"
15 | },
16 | "repository": {
17 | "type": "git",
18 | "url": "git+https://github.com/vuejs/vuepress.git",
19 | "directory": "packages/@vuepress/types"
20 | },
21 | "license": "MIT",
22 | "author": "ULIVZ",
23 | "main": "index.js",
24 | "types": "index.d.ts",
25 | "scripts": {
26 | "tsc": "tsc"
27 | },
28 | "dependencies": {
29 | "@types/markdown-it": "^10.0.0",
30 | "@types/webpack-dev-server": "^3",
31 | "webpack-chain": "^6.0.0"
32 | },
33 | "publishConfig": {
34 | "access": "public"
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/packages/@vuepress/types/src/index.ts:
--------------------------------------------------------------------------------
1 | export * from './config'
2 | export * from './locale'
3 | export * from './markdown'
4 | export * from './style'
5 | export * from './context'
6 | export * from './theme-default'
7 | export * from './theme'
8 | export * from './plugin'
9 | export * from './plugin-api'
10 | export * from "./third-party-plugins"
11 | export * from "./official-plugins"
12 |
--------------------------------------------------------------------------------
/packages/@vuepress/types/src/locale.ts:
--------------------------------------------------------------------------------
1 | import { Lang } from "./lang";
2 | /**
3 | * Local config.
4 | */
5 | export interface LocaleConfig {
6 | /**
7 | * Locale's lang
8 | */
9 | lang: Lang;
10 | /**
11 | * Locale's title
12 | */
13 | title: string;
14 | /**
15 | * Locale's description
16 | */
17 | description: string;
18 | }
19 |
20 | export type Locales = { [path: string]: LocaleConfig };
21 |
--------------------------------------------------------------------------------
/packages/@vuepress/types/src/shared.ts:
--------------------------------------------------------------------------------
1 | import ChainWebpackConfig from "webpack-chain";
2 |
3 | export type ChainWebpack = (config: ChainWebpackConfig, isServer: boolean) => void;
4 |
5 | export type Hook = (...arg: U) => R;
6 |
7 | export type AsyncHook = Hook<
8 | U,
9 | Promise
10 | >;
11 |
12 | export type PluginObject = Record;
--------------------------------------------------------------------------------
/packages/@vuepress/types/src/site-data.ts:
--------------------------------------------------------------------------------
1 | import { Page } from "./context";
2 | import { ThemeConfig } from "./theme";
3 | import { Locales } from "./locale";
4 | import { HeadTags } from "./config";
5 |
6 | export interface SiteData {
7 | title: string;
8 | description: string;
9 | base: string;
10 | pages: Page[];
11 | headTags: HeadTags;
12 | themeConfig: T;
13 | locales: Locales;
14 | }
15 |
--------------------------------------------------------------------------------
/packages/@vuepress/types/src/style.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * postcss-loader does not provide official typings, so we extract types from:
3 | *
4 | * @see https://github.com/webpack-contrib/postcss-loader/tree/v3.0.0
5 | */
6 | export interface PostCssLoaderOptions {
7 | /**
8 | * Postcss plugins
9 | */
10 | plugins?: unknown[];
11 | /**
12 | * Enables/Disables generation of source maps
13 | */
14 | sourceMap?: boolean;
15 | /**
16 | * Omit other options
17 | */
18 | [key: string]: any;
19 | }
20 |
--------------------------------------------------------------------------------
/packages/@vuepress/types/src/third-party-plugins.ts:
--------------------------------------------------------------------------------
1 | export type KnownThirdPartyPlugins =
2 | /**
3 | * Plugins from VuePress Community
4 | *
5 | * @see https://vuepress-community.netlify.app/en/plugins/clean-urls/
6 | */
7 | | "vuepress-plugin-container"
8 | | "vuepress-plugin-copyright"
9 | | "vuepress-plugin-dehydrate"
10 | | "vuepress-plugin-git-log"
11 | | "vuepress-plugin-mathjax"
12 | | "vuepress-plugin-medium-zoom"
13 | | "vuepress-plugin-migrate"
14 | | "vuepress-plugin-named-chunks"
15 | | "vuepress-plugin-nprogress"
16 | | "vuepress-plugin-redirect"
17 | | "vuepress-plugin-serve"
18 | | "vuepress-plugin-smooth-scroll"
19 | | "vuepress-plugin-table-of-contents"
20 | | "vuepress-plugin-typescript"
21 | | "vuepress-plugin-zooming"
22 | /**
23 | * Other third-party plugins.
24 | */
25 | | "vuepress-plugin-flowchart";
26 |
--------------------------------------------------------------------------------
/packages/@vuepress/types/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../../tsconfig.json",
3 | "compilerOptions": {
4 | "strict": true,
5 | "noEmit": true,
6 | "outDir": "./lib",
7 | "noImplicitAny": true
8 | },
9 | "include": ["./src"]
10 | }
11 |
--------------------------------------------------------------------------------
/packages/docs/.remarkrc:
--------------------------------------------------------------------------------
1 | {
2 | "plugins": [
3 | "preset-lint-recommended",
4 | "preset-lint-consistent",
5 |
6 | ["lint-list-item-indent", "space"],
7 | ["lint-heading-style", false]
8 | ]
9 | }
10 |
--------------------------------------------------------------------------------
/packages/docs/.textlintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | rules: {
3 | "@textlint-rule/no-unmatched-pair": true,
4 | apostrophe: true,
5 | "common-misspellings": true,
6 | diacritics: true,
7 | "en-capitalization": false,
8 | "stop-words": {
9 | severity: "warning"
10 | },
11 | terminology: {
12 | terms: [
13 | "VuePress",
14 | "sass",
15 | [
16 | "front[- ]matter",
17 | "frontmatter"
18 | ]
19 | ]
20 | },
21 | "write-good": {
22 | severity: "warning"
23 | }
24 | },
25 | filters: {
26 | comments: true
27 | }
28 | };
29 |
--------------------------------------------------------------------------------
/packages/docs/docs/.vuepress/components/Foo/Bar.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 | {{ msg }}
4 |
5 |
6 |
7 |
16 |
--------------------------------------------------------------------------------
/packages/docs/docs/.vuepress/components/OtherComponent.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 | This is another component
4 |
5 |
6 |
--------------------------------------------------------------------------------
/packages/docs/docs/.vuepress/components/UpgradePath.vue:
--------------------------------------------------------------------------------
1 |
23 |
24 |
36 |
--------------------------------------------------------------------------------
/packages/docs/docs/.vuepress/components/demo-1.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 | {{ msg }}
4 |
5 |
6 |
7 |
16 |
--------------------------------------------------------------------------------
/packages/docs/docs/.vuepress/components/svg-container.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 | Simplicity First
11 | Minimal setup with markdown-centered project structure helps you focus on writing.
12 |
13 |
14 | Vue-Powered
15 | Enjoy the dev experience of Vue + webpack, use Vue components in markdown, and develop custom themes with Vue.
16 |
17 |
18 | Performant
19 | VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
20 |
21 |
22 |
23 | ::: slot footer
24 | MIT Licensed | Copyright © 2018-present [Evan You](https://github.com/yyx990803)
25 | :::
--------------------------------------------------------------------------------
/packages/docs/docs/plugin/context-api.md:
--------------------------------------------------------------------------------
1 | # Context API
2 |
3 | Starting with VuePress 1.x.x, VuePress provides an `AppContext` object that stores all the state of the current app and can be accessed through the plugin API.
4 |
5 | ::: warning Note
6 | Context of each plugin is a isolated context inherited from the same app context.
7 | :::
8 |
9 | ```js
10 | module.exports = (options, ctx) => {
11 | // ...
12 | }
13 | ```
14 |
15 | ## ctx.isProd
16 |
17 | - Type: `boolean`
18 |
19 | Whether VuePress run in production environment mode.
20 |
21 | ## ctx.pages
22 |
23 | - Type: `array`
24 |
25 | Contains a list of Page objects
26 |
27 | ## ctx.sourceDir
28 |
29 | - Type: `string`
30 |
31 | Root directory where the documents are located.
32 |
33 | ## ctx.tempPath
34 |
35 | - Type: `string`
36 |
37 | Root directory where the temporary files are located.
38 |
39 | ## ctx.outDir
40 |
41 | - Type: `string`
42 |
43 | Output path.
44 |
45 | ## ctx.base
46 |
47 | - Type: `string`
48 |
49 | See: [base](../config/README.md#base).
50 |
51 | ## ctx.writeTemp
52 |
53 | - Type: `Function`
54 |
55 | A utility for writing temporary files to tempPath.
56 |
--------------------------------------------------------------------------------
/packages/docs/docs/plugin/life-cycle.md:
--------------------------------------------------------------------------------
1 | # Lifecycle
2 |
3 | ## ready
4 |
5 | - Type: `AsyncFunction`
6 | - Scope：`dev|build`
7 |
8 | ```js
9 | module.exports = {
10 | async ready() {
11 | // ...
12 | }
13 | }
14 | ```
15 |
16 | ::: tip
17 | The `ready` hook is executed after the application is initialized and before some specific functional APIs are executed. These functional APIs include:
18 |
19 | - [clientDynamicModules](./option-api.md#clientdynamicmodules)
20 | - [enhanceAppFiles](./option-api.md#enhanceappfiles)
21 |
22 | :::
23 |
24 | ## updated
25 |
26 | - Type: `Function`
27 | - Scope：`dev`
28 |
29 | ```js
30 | module.exports = {
31 | updated() {
32 | // ...
33 | }
34 | }
35 | ```
36 |
37 | ## generated
38 |
39 | - Type: `AsyncFunction`
40 | - Scope：`build`
41 |
42 | Called when a (production) build finishes, with an array of generated page HTML paths.
43 |
44 | ``` js
45 | module.exports = {
46 | async generated (pagePaths) {
47 | // ...
48 | }
49 | }
50 | ```
51 |
--------------------------------------------------------------------------------
/packages/docs/docs/plugin/official/plugin-active-header-links.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: active-header-links
3 | metaTitle: A plugin of automatically activating sidebar links when page scrolls | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-active-header-links](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-active-header-links)
7 |
8 | > A plugin of automatically activating sidebar links when page scrolls
9 |
10 | ## Install
11 |
12 | ```bash
13 | yarn add -D @vuepress/plugin-active-header-links
14 | # OR npm install -D @vuepress/plugin-active-header-links
15 | ```
16 |
17 | ## Usage
18 |
19 | ```javascript
20 | module.exports = {
21 | plugins: ['@vuepress/active-header-links']
22 | }
23 | ```
24 |
25 | ### Passing Options
26 |
27 | ```javascript
28 | module.exports = {
29 | plugins: ['@vuepress/active-header-links', {
30 | sidebarLinkSelector: '.sidebar-link',
31 | headerAnchorSelector: '.header-anchor'
32 | }]
33 | }
34 | ```
35 |
36 | ## Options
37 |
38 | ### sidebarLinkSelector
39 |
40 | - Type: `string`
41 | - Default: `.sidebar-link`
42 |
43 | ### headerAnchorSelector
44 |
45 | - Type: `string`
46 | - Default: `.header-anchor`
47 |
--------------------------------------------------------------------------------
/packages/docs/docs/plugin/official/plugin-back-to-top.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: back-to-top
3 | metaTitle: Back-To-Top Plugin | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-back-to-top](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-back-to-top)
7 |
8 | > Back-to-top plugin
9 |
10 | ## Install
11 |
12 | ```bash
13 | yarn add -D @vuepress/plugin-back-to-top
14 | # OR npm install -D @vuepress/plugin-back-to-top
15 | ```
16 |
17 | ## Usage
18 |
19 | ```javascript
20 | module.exports = {
21 | plugins: ['@vuepress/back-to-top']
22 | }
23 | ```
24 |
--------------------------------------------------------------------------------
/packages/docs/docs/plugin/official/plugin-blog.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: blog
3 | metaTitle: Blog plugin | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-blog](https://github.com/vuepressjs/vuepress-plugin-blog)
7 |
8 | ## Features
9 |
10 | - [**Classification**](https://vuepress-plugin-blog.billyyyyy3320.com/guide/getting-started.html#document-classifier):
11 | Powerful classification system lets you quickly classify your posts.
12 | - [**Pagination**](https://vuepress-plugin-blog.billyyyyy3320.com/guide/getting-started.html#pagination):
13 | Pagination runs through the entire plugin, and it has never been so simple.
14 | - [**Client APIs**](https://vuepress-plugin-blog.billyyyyy3320.com/client-api/): Simple client APIs make it easier for you to write a blog theme.
15 |
16 | ## Install
17 |
18 | We strongly recommend that you read the [Getting Started](https://vuepress-plugin-blog.billyyyyy3320.com/guide/getting-started.html) section before using this plugin.
19 |
20 | ```bash
21 | yarn add -D @vuepress/plugin-blog
22 | # OR npm install -D @vuepress/plugin-blog
23 | ```
24 |
25 | ## Usage
26 |
27 | ```javascript
28 | module.exports = {
29 | plugins: ['@vuepress/blog']
30 | }
31 | ```
32 |
33 | Please head [documentation](https://vuepress-theme-blog.billyyyyy3320.com/) to see all available options.
34 |
--------------------------------------------------------------------------------
/packages/docs/docs/plugin/official/plugin-google-analytics.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: google-analytics
3 | metaTitle: Google Analytics Plugin | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-google-analytics](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-google-analytics)
7 |
8 |
9 | > Google analytics plugin
10 |
11 | ## Install
12 |
13 | ```bash
14 | yarn add -D @vuepress/plugin-google-analytics
15 | # OR npm install -D @vuepress/plugin-google-analytics
16 | ```
17 |
18 | ::: warning
19 | We currently recommend using [Yarn](https://yarnpkg.com/en/) instead of npm to install all dependencies if you are using Google Analytics Plugin, because npm fails to generate the correct dependency tree in this case.
20 | :::
21 |
22 | ## Usage
23 |
24 | ```javascript
25 | module.exports = {
26 | plugins: [
27 | [
28 | '@vuepress/google-analytics',
29 | {
30 | 'ga': '' // UA-00000000-0
31 | }
32 | ]
33 | ]
34 | }
35 | ```
36 |
37 | ::: tip
38 | Please be aware of [GDPR (2018 reform of EU data protection rules)](https://ec.europa.eu/commission/priorities/justice-and-fundamental-rights/data-protection/2018-reform-eu-data-protection-rules_en) as IPs are anonymized automatically.
39 | :::
40 |
41 | ## Options
42 |
43 | ### ga
44 |
45 | - Type: `string`
46 | - Default: `undefined`
47 |
48 | Provide the Google Analytics ID to enable integration.
49 |
--------------------------------------------------------------------------------
/packages/docs/docs/plugin/official/plugin-nprogress.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: nprogress
3 | metaTitle: Nprogress Plugin | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-nprogress](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-nprogress)
7 |
8 | > A progress bar plugin based on [nprogress](https://github.com/rstacruz/nprogress).
9 |
10 | ## Install
11 |
12 | ```bash
13 | yarn add -D @vuepress/plugin-nprogress
14 | # OR npm install -D @vuepress/plugin-nprogress
15 | ```
16 |
17 | ## Usage
18 |
19 | ```javascript
20 | module.exports = {
21 | plugins: ['@vuepress/nprogress']
22 | }
23 | ```
24 |
25 | ## Custom color
26 |
27 | Set `$nprogressColor` in your __site__ or __theme__ `palette.styl` file to change the color of the progress bar (default is `$accentColor`).
28 |
29 | ```stylus
30 | // .vuepress/styles/palette.styl
31 | // or
32 | // .vuepress/theme/styles/palette.styl
33 |
34 | $nprogressColor = red
35 | ```
36 |
37 | __Also see:__
38 |
39 | - [Config Reference > Styling](../../config/README.md#styling)
40 |
--------------------------------------------------------------------------------
/packages/docs/docs/plugin/writing-a-plugin.md:
--------------------------------------------------------------------------------
1 | # Writing a Plugin
2 |
3 | A plugin should export a `plain JavaScript object`(`#1`). If the plugin needs to take options, it can be a function that returns a plain object(`#2`). The function will be called with the plugin’s options as the first argument, along with [ctx](./context-api.md) which provides some compile-time metadata.
4 |
5 | ``` js
6 | // #1
7 | module.exports = {
8 | // ...
9 | }
10 | ```
11 |
12 | ``` js
13 | // #2
14 | module.exports = (options, ctx) => {
15 | return {
16 | // ...
17 | }
18 | }
19 | ```
20 |
21 | ::: tip
22 | A VuePress plugin module should be a `CommonJS Module` because VuePress plugins runs on the Node.js side.
23 | :::
24 |
--------------------------------------------------------------------------------
/packages/docs/docs/theme/README.md:
--------------------------------------------------------------------------------
1 | # Theme
2 |
3 | ::: tip
4 | Theme components are under the same [browser API access restrictions](../guide/using-vue.md#browser-api-access-restrictions).
5 | :::
6 |
--------------------------------------------------------------------------------
/packages/docs/docs/theme/blog-theme.md:
--------------------------------------------------------------------------------
1 | # Blog theme
2 |
3 | ## Sites
4 |
5 | - [Documentation](https://vuepress-theme-blog.billyyyyy3320.com)
6 | - [Live Example](https://example.vuepress-theme-blog.billyyyyy3320.com/)
7 | - [Live Example - ULIVZ’s space](https://billyyyyy3320.com/)
8 | - [Live Example - Billyyyyy3320’s space](https://billyyyyy3320.com/)
9 |
10 | ## Install
11 |
12 | ```bash
13 | yarn add @vuepress/theme-blog -D
14 | # OR npm install @vuepress/theme-blog -D
15 | ```
16 | ## Usage
17 |
18 | ```js
19 | // .vuepress/config.js
20 | module.exports = {
21 | theme: '@vuepress/blog',
22 | themeConfig: {
23 | // Please read documentation to see the available options.
24 | }
25 | }
26 | ```
27 |
--------------------------------------------------------------------------------
/packages/docs/docs/theme/using-a-theme.md:
--------------------------------------------------------------------------------
1 | # Using a theme
2 |
3 | Using a theme is almost the same as using a plugin.
4 |
5 | ## Using a theme from a dependency
6 |
7 | Themes can be published on npm in raw Vue SFC format as `vuepress-theme-xxx`.
8 |
9 | ``` js
10 | // .vuepress/config.js
11 | module.exports = {
12 | theme: 'vuepress-theme-xx'
13 | }
14 | ```
15 |
16 | ## Theme Shorthand
17 |
18 | If you prefix the theme with `vuepress-theme-`, you can use a shorthand to leave out that prefix:
19 |
20 | ``` js
21 | // .vuepress/config.js
22 | module.exports = {
23 | theme: 'xxx'
24 | }
25 | ```
26 |
27 | Same with:
28 |
29 | ``` js
30 | // .vuepress/config.js
31 | module.exports = {
32 | theme: 'vuepress-theme-xxx'
33 | }
34 | ```
35 |
36 | This also works with [Scoped Packages](https://docs.npmjs.com/misc/scope):
37 |
38 | ``` js
39 | // .vuepress/config.js
40 | module.exports = {
41 | theme: '@org/vuepress-theme-xxx', // or an official theme: '@vuepress/theme-xxx'
42 | }
43 | ```
44 |
45 | Shorthand:
46 |
47 | ``` js
48 | // .vuepress/config.js
49 | module.exports = {
50 | theme: '@org/xxx', // or an official theme: '@vuepress/xxx'
51 | }
52 | ```
53 |
54 | ::: warning Note
55 | The theme whose name starts with `@vuepress/theme-` is an officially maintained theme.
56 | :::
57 |
--------------------------------------------------------------------------------
/packages/docs/docs/zh/README.md:
--------------------------------------------------------------------------------
1 | ---
2 | home: true
3 | heroImage: /hero.png
4 | actionText: 快速上手 →
5 | actionLink: /zh/guide/
6 | features:
7 | - title: 简洁至上
8 | details: 以 Markdown 为中心的项目结构，以最少的配置帮助你专注于写作。
9 | - title: Vue 驱动
10 | details: 享受 Vue + webpack 的开发体验，可以在 Markdown 中使用 Vue 组件，又可以使用 Vue 来开发自定义主题。
11 | - title: 高性能
12 | details: VuePress 会为每个页面预渲染生成静态的 HTML，同时，每个页面被加载的时候，将作为 SPA 运行。
13 | footer: MIT Licensed | Copyright © 2018-present Evan You
14 | ---
15 |
16 | ### 像数 1, 2, 3 一样容易
17 |
18 | ``` bash
19 | # 安装
20 | yarn global add vuepress # 或者：npm install -g vuepress
21 |
22 | # 新建一个 markdown 文件
23 | echo '# Hello VuePress!' > README.md
24 |
25 | # 开始写作
26 | vuepress dev .
27 |
28 | # 构建静态文件
29 | vuepress build .
30 | ```
31 |
32 | ::: warning 注意
33 | 请确保你的 Node.js 版本 >= 8.6。
34 | :::
35 |
--------------------------------------------------------------------------------
/packages/docs/docs/zh/api/cli.md:
--------------------------------------------------------------------------------
1 | # 命令行接口
2 |
3 | ## 基本用法
4 |
5 | ```bash
6 | vuepress targetDir [options]
7 | ```
8 |
9 | ## build
10 |
11 | 在指定的目录生成一个静态站点。
12 |
13 | ### -p, --port ``
14 | 查看 [port](../config/README.md#port)。
15 |
16 | ### -t, --temp ``
17 | 查看 [temp](../config/README.md#temp)。
18 |
19 | ### -c, --cache `[cache]`
20 | ### --no-cache
21 | 查看 [cache](../config/README.md#cache)。
22 |
23 | ### --dest ``
24 | 查看 [dest](../config/README.md#dest)。
25 |
26 | ### --debug
27 | 以调试模式启动开发服务器。
28 |
29 | ### --silent
30 | 以安静模式启动开发服务器。
31 |
32 | ### --max-concurrency
33 | 设置渲染文档的最大并发量，当渲染大量文档，可能造成内存溢出时使用
34 |
35 | ## dev
36 |
37 | 启动一个开发服务器。来自 `vuepress build` 的所有选项都可用。除此以外，还有几个专门针对 dev 的选项：
38 |
39 | ### --host ``
40 | 查看 [host](../config/README.md#host)。
41 |
42 | ### --open
43 | 当服务端准备就绪时自动打开浏览器。
44 |
45 | ### --no-clear-screen
46 | 当 dev server 就绪时不清除屏幕。请注意 dev server 不会在调试模式下清除屏幕。
47 |
48 | ## eject
49 |
50 | 将默认主题复制到 `.vuepress/theme` 目录，以供自定义。
51 |
52 | ## 更多指令
53 |
54 | 你可以使用 [extendCli](../plugin/option-api.md#extendcli) 来创建自定义命令。
55 |
--------------------------------------------------------------------------------
/packages/docs/docs/zh/plugin/context-api.md:
--------------------------------------------------------------------------------
1 | # Context API
2 |
3 | VuePress 提供了一个存储了当前页面所有状态的 Context API。
4 |
5 | ::: tip 提示
6 | 每个函数式插件的上下文对象是一个继承于根上下文的隔离上下文对象。
7 | :::
8 |
9 | ```js
10 | module.exports = (options, ctx) => {
11 | // ...
12 | }
13 | ```
14 |
15 | ## ctx.isProd
16 |
17 | - 类型: `boolean`
18 |
19 | VuePress 是否运行在生产环境模式下。
20 |
21 | ## ctx.pages
22 |
23 | - 类型: `array`
24 |
25 | 一个包含了页面对象的列表。
26 |
27 | ## ctx.sourceDir
28 |
29 | - 类型: `string`
30 |
31 | 文档的根目录路径。
32 |
33 | ## ctx.tempPath
34 |
35 | - 类型: `string`
36 |
37 | 临时文件所在的根目录路径。
38 |
39 | ## ctx.outDir
40 |
41 | - 类型: `string`
42 |
43 | 输出目录。
44 |
45 | ## ctx.base
46 |
47 | - 类型: `string`
48 |
49 | 参考: [base](../config/README.md#base).
50 |
51 | ## ctx.writeTemp
52 |
53 | - 类型: `Function`
54 |
55 | 一个用于向 tempPath 写入临时文件的方法。
56 |
--------------------------------------------------------------------------------
/packages/docs/docs/zh/plugin/life-cycle.md:
--------------------------------------------------------------------------------
1 | # 生命周期
2 |
3 | ## ready
4 |
5 | - 类型: `AsyncFunction`
6 | - 作用域：`dev|build`
7 |
8 | ```js
9 | module.exports = {
10 | async ready() {
11 | // ...
12 | }
13 | }
14 | ```
15 |
16 | ::: tip 提示
17 |
18 | `ready` 钩子在应用初始化之后，并在某些特定的函数式 API 执行之前执行。这些函数式 API 包括：
19 |
20 | - [clientDynamicModules](./option-api.md#clientdynamicmodules)
21 | - [enhanceAppFiles](./option-api.md#enhanceappfiles)
22 |
23 | :::
24 |
25 | ## updated
26 |
27 | - 类型: `Function`
28 | - 作用域：`dev`
29 |
30 | ```js
31 | module.exports = {
32 | updated() {
33 | // ...
34 | }
35 | }
36 | ```
37 |
38 | ## generated
39 |
40 | - 类型: `AsyncFunction`
41 | - 作用域：`build`
42 |
43 | 在生产环境的构建结束后被调用，生成的页面的路径数组将作为该函数的第一个参数。
44 |
45 | ``` js
46 | module.exports = {
47 | async generated (pagePaths) {
48 | // ...
49 | }
50 | }
51 | ```
52 |
--------------------------------------------------------------------------------
/packages/docs/docs/zh/plugin/official/plugin-active-header-links.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: active-header-links
3 | metaTitle: 页面滚动时自动激活侧边栏链接的插件 | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-active-header-links](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-active-header-links)
7 |
8 | > 页面滚动时自动激活侧边栏链接的插件
9 |
10 | ## 安装
11 |
12 | ```bash
13 | yarn add -D @vuepress/plugin-active-header-links
14 | # OR npm install -D @vuepress/plugin-active-header-links
15 | ```
16 |
17 | ## 使用
18 |
19 | ```javascript
20 | module.exports = {
21 | plugins: ['@vuepress/active-header-links']
22 | }
23 | ```
24 |
25 | ### 配置选项
26 |
27 | ```javascript
28 | module.exports = {
29 | plugins: ['@vuepress/active-header-links', {
30 | sidebarLinkSelector: '.sidebar-link',
31 | headerAnchorSelector: '.header-anchor'
32 | }]
33 | }
34 | ```
35 |
36 | ## 选项
37 |
38 | ### sidebarLinkSelector
39 |
40 | - 类型: `string`
41 | - 默认值: `.sidebar-link`
42 |
43 | ### headerAnchorSelector
44 |
45 | - 类型: `string`
46 | - 默认值: `.header-anchor`
47 |
--------------------------------------------------------------------------------
/packages/docs/docs/zh/plugin/official/plugin-back-to-top.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: back-to-top
3 | metaTitle: Back-To-Top 插件 | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-back-to-top](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-back-to-top)
7 |
8 | > back-to-top 插件.
9 |
10 | ## 安装
11 |
12 | ```bash
13 | yarn add -D @vuepress/plugin-back-to-top
14 | # OR npm install -D @vuepress/plugin-back-to-top
15 | ```
16 |
17 | ## 使用
18 |
19 | ```javascript
20 | module.exports = {
21 | plugins: ['@vuepress/back-to-top']
22 | }
23 | ```
24 |
--------------------------------------------------------------------------------
/packages/docs/docs/zh/plugin/official/plugin-blog.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: blog
3 | metaTitle: 博客插件 | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-blog](https://github.com/vuepressjs/vuepress-plugin-blog)
7 |
8 | ## 功能
9 |
10 | - [**分类**](https://vuepress-plugin-blog.billyyyyy3320.com/guide/getting-started.html#document-classifier)：强大的分类系统让你快速将贴文分类。
11 | - [**分页**](https://vuepress-plugin-blog.billyyyyy3320.com/guide/getting-started.html#pagination)： 极其简单的开箱即用的分页功能。
12 | - [**客户端 API**](https://vuepress-plugin-blog.billyyyyy3320.com/client-api/): 透过客户端 API 轻松地写一个博客主题。
13 |
14 | ## 安装
15 |
16 | 在使用这个插件之前，我们强烈建议你先阅读 [Getting Started](https://vuepress-plugin-blog.billyyyyy3320.com/guide/getting-started.html)。
17 |
18 | ```bash
19 | yarn add -D @vuepress/plugin-blog
20 | # OR npm install -D @vuepress/plugin-blog
21 | ```
22 |
23 | ## 使用
24 |
25 | ```javascript
26 | module.exports = {
27 | plugins: ['@vuepress/blog']
28 | }
29 | ```
30 |
31 | 参考 [文档](https://vuepress-theme-blog.billyyyyy3320.com/) 来查看所有可用的选项。
32 |
--------------------------------------------------------------------------------
/packages/docs/docs/zh/plugin/official/plugin-google-analytics.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: google-analytics
3 | metaTitle: Google Analytics 插件 | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-google-analytics](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-google-analytics)
7 |
8 | > Google analytics 插件
9 |
10 | ## 安装
11 |
12 | ```bash
13 | yarn add -D @vuepress/plugin-google-analytics
14 | # OR npm install -D @vuepress/plugin-google-analytics
15 | ```
16 |
17 | ::: warning
18 | 如果你的项目正在使用 Google analytics 插件，推荐使用 [Yarn](https://yarnpkg.com/en/) 而不是 npm 来安装所有依赖。因为在这种情形下，npm 会生成错误的依赖树。
19 | :::
20 |
21 | ## 使用
22 |
23 | ```javascript
24 | module.exports = {
25 | plugins: [
26 | [
27 | '@vuepress/google-analytics',
28 | {
29 | 'ga': '' // UA-00000000-0
30 | }
31 | ]
32 | ]
33 | }
34 | ```
35 |
36 | ::: tip 提示
37 | 请留意 [GDPR (2018年欧盟数据保护规则改革)](https://ec.europa.eu/commission/priorities/justice-and-fundamental-rights/data-protection/2018-reform-eu-data-protection-rules_en), 在合适或者需要的情况下，考虑将 Google Analytics 设置为[匿名化的 IP](https://support.google.com/analytics/answer/2763052?hl=zh-Hans)。
38 | :::
39 |
40 | ## 选项
41 |
42 | ### ga
43 |
44 | - 类型: `string`
45 | - 默认值: `undefined`
46 |
47 | 提供 Google Analytics ID 以启用集成。
48 |
--------------------------------------------------------------------------------
/packages/docs/docs/zh/plugin/official/plugin-medium-zoom.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: medium-zoom
3 | metaTitle: Medium-Zoom 插件 | VuePress
4 | ---
5 |
6 | # [@vuepress/plugin-medium-zoom](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-medium-zoom)
7 |
8 | > [medium-zoom](https://github.com/francoischalifour/medium-zoom) 插件
9 |
10 | ## 安装
11 |
12 | ```bash
13 | yarn add -D @vuepress/plugin-medium-zoom
14 | # OR npm install -D @vuepress/plugin-medium-zoom
15 | ```
16 |
17 | ## 使用
18 |
19 | **简单使用**:
20 |
21 | ```javascript
22 | module.exports = {
23 | plugins: ['@vuepress/medium-zoom']
24 | }
25 | ```
26 |
27 | **自定义选项**:
28 |
29 | ```javascript
30 | module.exports = {
31 | plugins: {
32 | '@vuepress/medium-zoom': {
33 | selector: 'img.zoom-custom-imgs',
34 | // medium-zoom options here
35 | // See: https://github.com/francoischalifour/medium-zoom#options
36 | options: {
37 | margin: 16
38 | }
39 | }
40 | }
41 | }
42 | ```
43 |
44 | ## 选项
45 |
46 | ### selector
47 |
48 | - 类型: `string`
49 | - 默认值: `.theme-default-content :not(a) > img`
50 |
51 | 值得注意的是， `.theme-default-content` 是默认主题添加给 [`}
15 | */
16 |
17 | async function CLI ({
18 | beforeParse,
19 | afterParse
20 | }) {
21 | const cli = CAC()
22 | beforeParse && await beforeParse(cli)
23 | cli.parse(process.argv)
24 | afterParse && await afterParse(cli)
25 | }
26 |
27 | /**
28 | * Wrap a function to catch error.
29 | * @param {function} fn
30 | * @returns {function(...[*]): (*|Promise|Promise)}
31 | */
32 |
33 | function wrapCommand (fn) {
34 | return (...args) => {
35 | return fn(...args).catch(err => {
36 | console.error(chalk.red(err.stack))
37 | process.exitCode = 1
38 | })
39 | }
40 | }
41 |
42 | /**
43 | * Check if a command is built-in
44 | * @param {array} argv
45 | * @returns {boolean}
46 | */
47 |
48 | function isKnownCommand (argv) {
49 | return ['dev', 'build', 'eject', 'info'].includes(argv[0])
50 | }
51 |
52 | module.exports = {
53 | CLI,
54 | isKnownCommand,
55 | wrapCommand
56 | }
57 |
--------------------------------------------------------------------------------
/scripts/jest.config.js:
--------------------------------------------------------------------------------
1 | const path = require('upath')
2 | const { createJestConfig } = require('@vuepress/test-utils')
3 |
4 | module.exports = createJestConfig({
5 | rootDir: path.resolve(__dirname, '..'),
6 | moduleNameMapper: {
7 | '^@/(.*)$': '/$1',
8 | '^@core/(.*)$': '/packages/@vuepress/core/$1',
9 | '^@theme/(.*)$': '/packages/@vuepress/theme-default/$1',
10 | '^@temp/(.*)$': '/.temp/$1',
11 | '^@internal/(.*)$': '/.temp/internal/$1',
12 | '^@transform/(.*)$': '/.temp/transform/$1'
13 | },
14 | modulePathIgnorePatterns: [
15 | '/packages/@vuepress/core/__test__/plugin-api/AsyncOption.spec.js'
16 | ]
17 | })
18 |
--------------------------------------------------------------------------------
/scripts/remote-version.js:
--------------------------------------------------------------------------------
1 | const { join } = require('path')
2 | const { readdirSync } = require('fs')
3 | const chalk = require('chalk')
4 | const execa = require('execa')
5 |
6 | const PRIVATE_PACKAGES = ['theme-vue', '.DS_Store']
7 |
8 | const scopePackages = readdirSync(
9 | join(__dirname, '../packages/@vuepress')
10 | )
11 | .filter(n => !PRIVATE_PACKAGES.includes(n))
12 | .map(n => `@vuepress/${n}`)
13 |
14 | async function log () {
15 | await Promise.all(['vuepress', ...scopePackages].map(async pkg => {
16 | const version = (await execa('npm', ['view', `${pkg}@next`, 'version'])).stdout.toString()
17 | console.log(`${pkg}: ${chalk.cyan(version)}`)
18 | }))
19 | }
20 |
21 | log()
22 |
--------------------------------------------------------------------------------
/scripts/test.js:
--------------------------------------------------------------------------------
1 | const minimist = require('minimist')
2 | const { createJestRunner } = require('@vuepress/test-utils')
3 | const { createApp } = require('@vuepress/core')
4 |
5 | const rawArgs = process.argv.slice(2)
6 | const args = minimist(rawArgs)
7 |
8 | let regex
9 | const debug = !!args['inspect-brk']
10 |
11 | if (args.p || args.package) {
12 | const packages = (args.p || args.package).split(',').join('|')
13 | regex = `.*@vuepress/(${packages}|plugin-(${packages}))/.*\\.spec\\.(js|ts)$`
14 | const i = rawArgs.indexOf('-p')
15 | rawArgs.splice(i, 2)
16 | }
17 |
18 | const jestRunner = createJestRunner([
19 | '--config', 'scripts/jest.config.js',
20 | '--runInBand',
21 | ...(regex ? [regex] : [])
22 | ], debug)
23 |
24 | // ensure the basic temp files were generated
25 | createApp({
26 | temp: '.temp'
27 | })
28 | .process()
29 | .then(() => jestRunner())
30 | .catch(err => {
31 | console.error(err)
32 | process.exit(1)
33 | })
34 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "target": "es2018",
4 | "declaration": true,
5 | "esModuleInterop": true,
6 | "pretty": true,
7 | "moduleResolution": "node",
8 | "lib": ["es2015", "es2016.array.include","DOM"],
9 | "allowSyntheticDefaultImports": true,
10 | "stripInternal": true,
11 | "noImplicitAny": false,
12 | "noImplicitReturns": true,
13 | "noImplicitThis": true,
14 | "noUnusedParameters": true,
15 | "noFallthroughCasesInSwitch": true,
16 | "resolveJsonModule": true,
17 | "strictNullChecks": true,
18 | "strictFunctionTypes": true,
19 | "alwaysStrict": true,
20 | "module": "commonjs",
21 | "outDir": "lib",
22 | "typeRoots": [
23 | "node_modules/@types"
24 | ]
25 | },
26 | "exclude": [
27 | "node_modules",
28 | "**/*.spec.ts"
29 | ]
30 | }
31 |
--------------------------------------------------------------------------------