https://github.com/microappjs/plugin-vuepress

[Plugin] adapter vuepress plugin.
https://github.com/microappjs/plugin-vuepress

cli micro-app microapp plugin-vuepress vuepress

Last synced: 4 months ago
JSON representation

[Plugin] adapter vuepress plugin.

• Host: GitHub
• URL: https://github.com/microappjs/plugin-vuepress
• Owner: MicroAppJS
• License: mit
• Created: 2019-10-21T11:52:43.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2025-04-09T13:52:58.000Z (9 months ago)
• Last Synced: 2025-08-08T19:37:51.290Z (5 months ago)
• Topics: cli, micro-app, microapp, plugin-vuepress, vuepress
• Language: JavaScript
• Homepage: https://MicroAppJS.github.io/vuepress
• Size: 3.19 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Micro APP Plugin - VuePress

[Plugin] adapter vuepress plugin & theme.

适配集成 vuepress 配置. 用于 `@micro-app/cli` 的插件.

[![Github Actions Coveralls][Github-Actions-Coveralls]][Github-Actions-Coveralls-url]

[![Coverage Status][Coverage-img]][Coverage-url]

[![NPM Version][npm-img]][npm-url]

[![NPM Download][download-img]][download-url]

[Github-Actions-Coveralls]: https://github.com/MicroAppJS/plugin-vuepress/workflows/Coveralls/badge.svg

[Github-Actions-Coveralls-url]: https://github.com/MicroAppJS/plugin-vuepress

[Coverage-img]: https://coveralls.io/repos/github/MicroAppJS/plugin-vuepress/badge.svg?branch=master

[Coverage-url]: https://coveralls.io/github/MicroAppJS/plugin-vuepress?branch=master

[npm-img]: https://img.shields.io/npm/v/@micro-app/plugin-vuepress.svg?style=flat-square

[npm-url]: https://npmjs.org/package/@micro-app/plugin-vuepress

[download-img]: https://img.shields.io/npm/dm/@micro-app/plugin-vuepress.svg?style=flat-square

[download-url]: https://npmjs.org/package/@micro-app/plugin-vuepress

## Install

```sh

yarn add @micro-app/plugin-vuepress

```

or

```sh

npm install -S @micro-app/plugin-vuepress

```

## Usage

### 在项目 `根目录` 的 `micro-app.config.js` 文件中配置

```js

module.exports = {

    // ...

    plugins: [ // 自定义插件

        [ '@micro-app/plugin-vuepress', {

            // default config

            {

            }

        } ],

    ],

};

```

### 创建 `micro-app.vuepress.config.js` 文件, 并如下配置

```js

{ // temp demo

    title: 'Micro App',

    sourceDir: 'docs',

    sidebar: {

        ...

    },

    nav: [],

    locales: {

        '/': {

            lang: 'zh-CN',

            description: '🔌 多模块可插拔插件的微应用框架',

            label: '简体中文',

            selectText: '选择语言',

            lastUpdated: '上次编辑时间',

            repoLabel: '查看源码',

            editLinkText: '在 GitHub 上编辑此页',

        },

        '/en/': {

            lang: 'en-US',

            description: '🔌 Pluggable Micro Application Framework',

            label: 'English',

            selectText: 'Languages',

            lastUpdated: 'Last Updated',

            repoLabel: 'View Code',

            editLinkText: 'Edit this page on GitHub',

        },

    },

    // 假定是 GitHub. 同时也可以是一个完整的 GitLab URL

    repo: 'MicroAppJS/MicroApp-Core',

    // 自定义仓库链接文字。默认从 `themeConfig.repo` 中自动推断为

    // "GitHub"/"GitLab"/"Bitbucket" 其中之一，或是 "Source"。

    // repoLabel: '查看源码',

    // 假如你的文档仓库和项目本身不在一个仓库：

    // docsRepo: 'MicroAppJS/MicroApp-Core',

    // 假如文档不是放在仓库的根目录下：

    docsDir: 'docs',

    // 假如文档放在一个特定的分支下：

    docsBranch: 'master',

    // 默认是 false, 设置为 true 来启用

    editLinks: true,

    // 默认为 "Edit this page"

    // editLinkText: '帮助我们改善此页面！',

    sidebarDepth: 3,

    // algolia: {

    //     indexName: "cli_vuejs",

    //     apiKey: "f6df220f7d246aff64a56300b7f19f21"

    // },

    // search: false,

    // searchMaxSuggestions: 10,

    // displayAllHeaders: true // 默认值：false

}

```