xjl-vuepress

Minimalistic doc generator with Vue component based layout system

Usage no npm install needed!

<script type="module">
  import xjlVuepress from 'https://cdn.skypack.dev/xjl-vuepress';
</script>

README

logo

Downloads Version License

VuePress

Minimalistic docs generator with Vue component based layout system

https://vuepress.vuejs.org/

Features

Built-in markdown extensions

Using Vue in Markdown

Vue-powered custom theme system

Default theme

Miscellaneous

Showcase

Websites built with VuePress:

Vue Ecosystem

Community

Todo Features

VuePress is still a work in progress. There are a few things that it currently does not support but are planned:

  • Plugin support
  • Blogging support

Contributions are welcome!

Development

Please make sure your version of Node.js is greater than 8.

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

License

MIT