Détail du package

@vuepress/core

vuejs340.6kMIT1.9.10

Minimalistic doc generator with Vue component based layout system

documentation, generator, vue

readme

logo

Downloads Version License VuePress channel on Discord

Status

VuePress is now in maintenance mode. For a next-gen Vue-based SSG built on top of Vue 3 + Vite, check out VitePress.

Documentation

Check out our docs at https://vuepress.vuejs.org/.

Showcase

Contribution

Want to contribute? Check our Contributing Guide and issues for beginners!

yarn install # install all dependencies
yarn dev  # serves VuePress' own docs with itself
yarn test # make sure your code change pass the test

If you don't have a local checkout, you can also open VuePress in Gitpod, a free online IDE for GitHub.

If you intend to make "substantial" changes to VuePress or its documentation, please checkout VuePress RFCs.

If you have a VuePress-related project/component/tool, add it with a pull request to this curated list!

Contributors

Creator / Lead

Evan You
Evan You

💻
ULIVZ
ULIVZ

💻 📖

Active Core Team

Billyyyyy3320
Billyyyyy3320

💻
meteorlxy
meteorlxy

💻
Ramona
Ramona

💻 📖
Franck Abgrall
Franck Abgrall

💻 💬

Core Team Emeriti

Here we honor some no-longer-active core team members who have made valuable contributions in the past.

Ben Hong
Ben Hong

💻 📖 💬
Giraud Florent
Giraud Florent

💻
Sarah Dayan
Sarah Dayan

💻 📖
Vinayak Kulkarni
Vinayak Kulkarni

🔌 💻 📝
Victoria Bergquist
Victoria Bergquist

💻 🎨
Nikita Sobolev
Nikita Sobolev

💻 📖
Fatih Acet
Fatih Acet

💻
Vladimir Pouzanov
Vladimir Pouzanov

💻

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

MIT

changelog

1.9.9 (2023-02-25)

Bug Fixes

1.9.8 (2023-01-06)

Bug Fixes

1.9.7 (2022-01-18)

Bug Fixes

  • types: missing ariaLabel at default theme config (a7b12bf) @ulivz

1.9.6 (2022-01-17)

Bug Fixes

Features

1.9.5 (2021-12-25)

Features

1.9.4 (2021-12-24)

Bug Fixes

  • types: '_filePath' implicitly has an 'any' type (66a6c27) @ulivz
  • types: add missing default theme config activeHeaderLinks (075ec62) @ulivz
  • types: cannot find module '../../shared-utils/src/datatypes' (e919d14) @ulivz

Features

1.9.3 (2021-12-23)

Bug Fixes

  • types: all plugin option api should be optional (b5c4744) @ulivz

1.9.2 (2021-12-23)

Bug Fixes

  • types: regression issue of reusing define helpers (f0ba93c) @ulivz

Features

  • types: definePluginEntry helper to infer type for plugin entry (cb07377) @ulivz
  • types: defineThemeEntry helper to infer type for theme entry (84250cc) @ulivz
  • types: init @vuepress/types (7ac6aa8) @ulivz

1.9.1 (2021-12-22)

Bug Fixes

  • types: support plain string usage for known third-party plugins (dd6e3ef) @ulivz

1.9.0 (2021-12-22)

Features

For more information please head VuePress 1.9.

1.8.3 (2021-12-20)

Bug Fixes

Features

1.8.2 (2021-02-18)

Bug Fixes

1.8.2 (2021-02-18)

Bug Fixes

1.8.1 (2021-02-11)

Bug Fixes

1.8.0 (2021-01-05)

Bug Fixes

Features

1.7.1 (2020-10-15)

Bug Fixes

1.7.0 (2020-10-13)

Bug Fixes

Features

1.6.0 (2020-09-25)

Features

1.5.4 (2020-08-23)

Bug Fixes

1.5.3 (2020-08-05)

Bug Fixes

Features

1.5.2 (2020-06-14)

Bug Fixes

Features

1.5.1 (2020-06-09)

Bug Fixes

1.5.0 (2020-05-11)

Bug Fixes

Features

Reverts

1.4.1 (2020-04-15)

Bug Fixes

1.4.0 (2020-03-18)

Bug Fixes

Features

1.3.1 (2020-02-20)

Bug Fixes

Features

1.3.0 (2020-01-30)

Bug Fixes

Features

1.2.0 (2019-10-11)

Bug Fixes

Features

1.1.0 (2019-09-14)

Bug Fixes

Features

1.0.4 (2019-09-06)

Bug Fixes

Features

1.0.3 (2019-07-29)

Bug Fixes

Features

1.0.2 (2019-06-22)

Bug Fixes

Features

1.0.1 (2019-06-10)

Bug Fixes

Features

  • $theme-default: enhance the styles of blockquote (9d20d5f) @ulivz

1.0.0 (2019-06-08)

1.0.0-rc.1 (2019-06-08)

It seems no any changes here.

1.0.0-beta.2 (2019-06-05)

Bug Fixes

  • $core: failed to render <Content /> with dynamic pageKey from current $page. (83b02ba) @ulivz

(2019-06-05)

1.0.0-beta.1 (2019-06-04)

Features

BREAKING CHANGES

  • Deprecated @vuepress/plugin-blog at alpha stage. (10dfb66) @ulivz
  • Deprecated @vuepress/plugin-pagination at alpha stage. (3722192) @ulivz

1.0.0-alpha.50 (2019-06-04)

Bug Fixes

1.0.0-alpha.49 (2019-06-03)

Bug Fixes

  • $core: cannot load theme with shortcut. (7eed1f4) @ulivz
  • $core: cannot retrieve the correct theme name when them path is a local absolute path linked to a javascript file. (50f64b4) @ulivz

Features

  • $core: global variable "VUEPRESS" to store runtime key infos (bd0bdf9) @ulivz
  • $core: safer class name of content outlet (7d0542e) @ulivz
  • $theme-default: using '.theme-default-content' to replace '.content' in <Content /> outlet. (85ff630) @ulivz

1.0.0-alpha.48 (2019-05-14)

Bug Fixes

Features

1.0.0-alpha.47 (2019-04-06)

Bug Fixes

Features

1.0.0-alpha.46 (2019-04-01)

Bug Fixes

1.0.0-alpha.45 (2019-03-31)

Bug Fixes

Features

Breaking Changes

1.0.0-alpha.44 (2019-03-10)

Features

  • $core: optional callback when socket connection is ready under dev. (547e4f9) @ulivz
  • $core: return current app instance in node api (1c2a6b2) @ulivz

1.0.0-alpha.43 (2019-03-09)

Bug Fixes

Features

1.0.0-alpha.42 (2019-03-03)

Bug Fixes

1.0.0-alpha.41 (2019-03-02)

Bug Fixes

Features

1.0.0-alpha.40 (2019-02-27)

Bug Fixes

Features

1.0.0-alpha.39 (2019-02-17)

Bug Fixes

1.0.0-alpha.38 (2019-02-16)

Bug Fixes

Features

1.0.0-alpha.37 (2019-02-08)

Features

  • $core: redirects for clean urls (#1269) (213bb34) @ulivz
  • $theme-default: fallback current group node to page node if children doesn't exist (11ce576) @ulivz
  • $theme-default: highlight sidebar link text at root level like sidebar group heading text (05e793f) @ulivz
  • $theme-default: unify the text color of sidebar heading text and root-level sidebar link (3e47a20) @ulivz

1.0.0-alpha.36 (2019-02-03)

Bug Fixes

Features

  • $theme-default: refine sidebar groups (#1257) (01dd45b) @ulivz closes #814 #783 #287
    • sidebarDepth for a specified sidebar group.
    • Nested sidebar groups.
    • Clickable heading for sidebar groups.

1.0.0-alpha.35 (2019-01-30)

Bug Fixes

Features

  • $core: exclude temp dir from being ignored watching (c6797dd) @ulivz

1.0.0-alpha.34 (2019-01-29)

Bug Fixes

Features

  • $core: Support extra watching files (02cc268) @ulivz
    e.g.
    // .vuepress/config.js
    module.exports = {
      extraWatchFiles: [
        require.resolve('./sidebar.js')
        // or '.vuepress/sidebar.js'
      ]
    }
    

1.0.0-alpha.33 (2019-01-27)

Features

BREAKING CHANGES

  • $core: - Plugin option enhanceDevServer was removed.
    • For 0.x users, there is no any effect since we didn't expose API to modify it.
    • For 1.x users whose version of VuePress is lower than 1.0.0-alpha.33, you should use beforeDevServer(i.e. before in webpack-dev-server) to replace enhanceDevServer, you can also use afterDevServer(i.e. after in webpack-dev-server) to execute custom middleware after all other middleware internally within the server.

1.0.0-alpha.32 (2019-01-15)

Bug Fixes

1.0.0-alpha.31 (2019-01-10)

Bug Fixes

Features

1.0.0-alpha.30 (2018-12-18)

Features

Breaking Changes

Performance Improvements

1.0.0-alpha.29 (2018-12-13)

Bug Fixes

1.0.0-alpha.28 (2018-12-12)

Bug Fixes

Features

1.0.0-alpha.27 (2018-12-03)

Bug Fixes

1.0.0-alpha.26 (2018-12-02)

Bug Fixes

  • $core: changing frontmatter always took a long time to refresh page (68add19) @ulivz
    • From now on AppContext has become a singleton.

Features

  • $cli: allow unknown options in dev and build command (0ecd099) @ulivz
  • $core: debug to see performance (0876491) @ulivz
    • Using --developer flag to see the performance for 1st dev and build. note that --developer flag is a separate flag which doesn't have log level.
  • $core: support Vue SFCs as source files (dfb0bba) @ulivz
    • Note that when Vue SFCs are source files, VuePress will treat them as layout components directly.

1.0.0-alpha.25 (2018-11-29)

Bug Fixes

Features

1.0.0-alpha.24 (2018-11-25)

Bug Fixes

Features

1.0.0-alpha.23 (2018-11-18)

Bug Fixes

Features

1.0.0-alpha.22 (2018-11-13)

Bug Fixes

  • $core: .vuepress/style.styl does not take effect in the production environment. (#977) (2dafd88) @ulivz

1.0.0-alpha.21 (2018-11-13)

Bug Fixes

Features

1.0.0-alpha.20 (2018-11-09)

Bug Fixes

Features

1.0.0-alpha.19 (2018-11-06)

Bug Fixes

  • $plugin-active-header-links: unexpected error when anchors were empty (d658169) @ulivz

Features

  • $markdown-loader: AsyncMarkdownContentLoaded event (6f52012) @ulivz
  • $plugin-active-header-links: sidebarLinkSelector & headerAnchorSelector option (3a79635) @ulivz
  • $core: built-in content loading (216d04a) @ulivz
  • $core: Client VuePress Plugin (9c947b2) @ulivz
  • $core: 'contentLoading' site config option (f8e42bc) @ulivz
  • $plugin-medium-zoom: support selector option. (ce7da09) @ulivz
  • $theme-default: display els of page bottom after content mounted (d9a8ced) @ulivz

1.0.0-alpha.18 (2018-10-29)

Bug Fixes

Features

  • $new-package: @vuepress/theme-vue (cb87532) @ulivz
  • $core: extend option API for a theme (84fd0ff) @ulivz
    • From now on, you can use the extend option to inherit an existing theme, and VuePres will automatically help you to resolve Layout components, palettes, styles, etc.

1.0.0-alpha.17 (2018-10-27)

Bug Fixes

Features

1.0.0-alpha.16 (2018-10-23)

Bug Fixes

  • $plugin-last-updated: unexpected warning of last-updated plugin. (daa4d09) @ulivz

1.0.0-alpha.15 (2018-10-23)

Bug Fixes

  • $core: cannot resolve local functional plugin name (e8a35be) @ulivz

1.0.0-alpha.14 (2018-10-23)

Bug Fixes

Features

1.0.0-alpha.13 (2018-10-17)

Bug Fixes

  • $markdown-loader: unexpected reload at dev when md contains frontmatter (54efcb8) @ulivz
  • $theme-default: remove custom layout legacy. (close: #935) (1f345d1) @ulivz

1.0.0-alpha.12 (2018-10-17)

Bug Fixes

1.0.0-alpha.11 (2018-10-15)

Bug Fixes

  • $plugin-last-updated: doesn't work due to internal api change (b8ce22c) @ulivz

1.0.0-alpha.10 (2018-10-14)

Bug Fixes

1.0.0-alpha.9 (2018-10-10)

Features

  • $core: register 'themePath/global-components' dir as global components (04588cc) @ulivz closes #916

1.0.0-alpha.8 (2018-10-07)

Bug Fixes

1.0.0-alpha.7 (2018-10-07)

Bug Fixes

1.0.0-alpha.6 (2018-10-07)

Bug Fixes

1.0.0-alpha.5 (2018-10-07)

Bug Fixes

Features

1.0.0-alpha.4 (2018-10-05)

Bug Fixes

Features

1.0.0-alpha.3 (2018-10-03)

Bug Fixes

Features

1.0.0-alpha.2 (2018-09-28)

Bug Fixes

Features

  • $core: do not register global components at themePath/components (close: #877) (4e8da95) @ulivz
  • $core: make palette globally enabled and improve doc (2b2e308) @ulivz
  • $core: multiple layout directories (20e520d) @ulivz
  • $core: support themeIndexFile.devTemplate/ssrTemplate (close: #882) (6c6225d) @ulivz

1.0.0-alpha.1 (2018-09-27)

Features

Internal Changes

0.14.5 (2018-11-13)

Bug Fixes

0.14.4 (2018-09-15)

Bug Fixes

0.14.3 (2018-09-13)

Bug Fixes

0.14.2 (2018-08-14)

Bug Fixes

0.14.1 (2018-08-09)

Bug Fixes

0.14.0 (2018-08-08)

Bug Fixes

Features

0.13.1 (2018-08-01)

Bug Fixes

0.13.0 (2018-07-28)

Bug Fixes

Features

0.12.0 (2018-07-12)

Bug Fixes

Features

0.11.0 (2018-07-08)

Bug Fixes

  • $default-theme: indent-styled code is invisible (close: #609) (fd46a26) @ulivz
  • $default-theme: cannot get sidebar when sidebar config contains non-ASCII chars. (close: #628) (8837e7a) @ulivz
  • $core: override style issues (close: #637) (#638) (f998802) @ulivz
    1. Duplicated generated override style.
    2. Unexpected style order, override style should be at the end of the extracted style bundle. (ref: mini-css-extract-plugin#130)

Features

0.10.2 (2018-06-20)

Bug Fixes

Features

0.10.1 (2018-06-08)

Bug Fixes

Features

0.10.0 (2018-05-25)

Features

0.9.1 (2018-05-25)

Bug Fixes

Features

0.9.0 (2018-05-22)

Bug Fixes

Features

Performance Improvements

0.8.4 (2018-04-24)

Bug Fixes

Features

0.8.3 (2018-04-23)

Bug Fixes

0.8.2 (2018-04-23)

Bug Fixes

Features

0.8.1 (2018-04-23)

Bug Fixes

0.8.0 (2018-04-23)

Bug Fixes

Features

0.7.1 (2018-04-20)

Bug Fixes

0.7.0 (2018-04-18)

Bug Fixes

Features

0.6.1 (2018-04-18)

Bug Fixes

Features

0.6.0 (2018-04-18)

Bug Fixes

Features

0.5.1 (2018-04-17)

Bug Fixes

Features

0.5.0 (2018-04-16)

Features

0.4.2 (2018-04-16)

Bug Fixes

0.4.1 (2018-04-16)

Bug Fixes

Features

0.4.0 (2018-04-15)

Features

0.3.3 (2018-04-15)

Bug Fixes

0.3.2 (2018-04-15)

Bug Fixes

Features

0.3.1 (2018-04-14)

Bug Fixes

Features

0.3.0 (2018-04-14)

0.2.2 (2018-04-14)

0.2.1 (2018-04-14)

Bug Fixes

  • fix vuepress cant resolve custom theme under .vuepress/theme (#3) (133bdb3) @lazzzis

0.2.0 (2018-04-13)

Features

0.1.0 (2018-04-12)

Bug Fixes

Features