Skip to content

vuepress/marketplace

Repository files navigation

Introduction

The repo holds the source code for the VuePress2 Marketplace website.

Adding your plugins and themes

You are free to add your plugins and themes to the site, just open a new PR.

  • To add a plugin, you should edit config/plugins/<category>.json and add your plugin to the end of proper list.
  • To add a theme, you should edit config/themes/<category>.json and add your plugin to the end of proper list.

If you believe you are building a powerful theme or plugin that can be list in multiple categories, you can add theme in multiple places.

These contents should be included in your PR body
  • My work is open source and licensed under MIT or Apache-2.0.
  • My work is a plugin or theme for VuePress 2, or tools related with VuePress 2.
  • My work is workable with latest VuePress 2 version now, and I will keep supporting later VuePress 2 versions. I promise if I abandon my project, I will open another PR to remove it.

For more details, see Contributing Guide

Requesting vuejs.press domain

You are free to request a vuejs.press subdomain for your plugin or theme.

You can apply a vuejs.press subdomain as long as you agree with the following rules:

  1. Your work should be open source and licensed under MIT or Apache-2.0.
  2. Your work should be plugin or theme for VuePress 2, or tools related with VuePress 2.
  3. Your work should be workable with latest VuePress 2 version unless the latest VuePress 2 version was released less than 30 days ago.
  4. Only documentation content is allowed at your subdomain. No other content is allowed, including any political, religious, or other controversial content.

You should add a new line in config/vuejs.press.zone, and we will sync that file with DNS provider manually.

These contents should be included in your PR body
  • My work is open source and licensed under MIT or Apache-2.0.
  • My work is a plugin or theme for VuePress 2, or tools related with VuePress 2.
  • My work is workable with latest VuePress 2 version now, and I will keep supporting later VuePress 2 versions. I promise if I abandon my project, I will open another PR to remove it.
  • I promise only documentation content is served at subdomain I apply to.

If you need algolia docsearch, you should modify config/crawler.config to add your plugin of theme.

For details, see Contributing Guide

License

CC0
To the extent possible under law, Mister-Hope has waived all copyright and related or neighboring rights to VuePress MarketPlace. This work is published from: China Mainland.