Code Monkey home page Code Monkey logo

plugin-vuepress's Introduction

Micro APP Plugin - VuePress

[Plugin] adapter vuepress plugin & theme.

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

Github Actions Coveralls Coverage Status NPM Version NPM Download

Install

yarn add @micro-app/plugin-vuepress

or

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

Usage

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

module.exports = {
    // ...

    plugins: [ // 自定义插件
        [ '@micro-app/plugin-vuepress', {
            // default config
            {

            }
        } ],
    ],
};

创建 micro-app.vuepress.config.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
}

plugin-vuepress's People

Contributors

dependabot[bot] avatar zyao89 avatar

Watchers

 avatar  avatar

Forkers

hongke516

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.