Giter Club home page Giter Club logo

bazaar's Introduction

SiYuan community bazaar

中文

Overview

The SiYuan community bazaar is divided into four parts:

  • Theme bazaar
  • Template bazaar
  • Icon bazaar
  • Widget bazaar

Please refer to the following methods for listing.

Push to theme bazaar

Please make sure that the root path of your theme repository contains at least the following files before listing (repo example):

  • theme.css
  • theme.json (please make sure the JSON format is correct)
  • preview.png (please compress the image size within 512 KB)
  • README.md (please note the case)

After confirmation, please create a pull request to the Community Bazaar repository and modify the themes.json file in it. This file is the index of all community theme repositories, the format is:

{
   "repos": [
     "username/reponame@commithash"
   ]
}

Among them, commithash, please fill in the Git commit hash of the latest released version on your theme repository, please use the full hash value instead of the 7-digit short value.

If the theme you developed has an updated version, please remember:

  • Update the version field in your theme.json
  • Create a Pull Request to the community bazaar

Push to template bazaar

Please make sure that the root path of your template repository contains at least the following files before listing (repo example):

  • template.json (please make sure the JSON format is correct)
  • preview.png (please compress the image size within 512 KB)
  • README.md (please note the case)

After confirmation, please create a pull request to the Community Bazaar repository and modify the themes.json file in it. This file is the index file of all community template repositories, the format is:

{
   "repos": [
     "username/reponame@commithash"
   ]
}

Among them, commithash, please fill in the Git commit hash of the latest released version on your template repository, please use the full hash value instead of the 7-digit short value.

If the template you developed has an updated version, please remember:

  • Update the version field in your template.json
  • Create a Pull Request to the community bazaar

Push to icon bazaar

Please make sure that the root path of your icon repository contains at least the following files before listing:

  • icon.js
  • icon.json (please make sure the JSON format is correct)
  • preview.png (please compress the image size within 512 KB)
  • README.md (please note the case)

After confirmation, please create a pull request to the Community Bazaar repository and modify the consi.json file in it. This file is the index of all community icon repositories, the format is:

{
   "repos": [
     "username/reponame@commithash"
   ]
}

Among them, commithash, please fill in the Git commit hash of the latest released version on your icon repository, please use the full hash value instead of the 7-digit short value.

If the icon you developed has an updated version, please remember:

  • Update the version field in your icon.json
  • Create a Pull Request to the community bazaar

Push to widget bazaar

Please make sure that the root path of your widget repository contains at least the following files before listing:

  • index.html
  • widget.json (please make sure the JSON format is correct)
  • preview.png (please compress the image size within 512 KB)
  • README.md (please note the case)

After confirmation, please create a pull request to the Community Bazaar repository and modify the consi.json file in it. This file is the index of all community icon repositories, the format is:

{
   "repos": [
     "username/reponame@commithash"
   ]
}

Among them, commithash, please fill in the Git commit hash of the latest released version on your icon repository, please use the full hash value instead of the 7-digit short value.

If the widget you developed has an updated version, please remember:

  • Update the version field in your widget.json
  • Create a Pull Request to the community bazaar

bazaar's People

Contributors

achuan-2 avatar 88250 avatar morganwan90 avatar zuoqiu-yingyi avatar royc01 avatar svchord avatar mindstudy avatar userzyf avatar langzhou avatar crowds21 avatar ufdxd avatar soltus avatar lanedu avatar zhangzz66 avatar ultrasonicer avatar yuuuxt avatar yyhcoppolo avatar lisontowind avatar mozhux avatar viwz avatar choyy avatar leolee9086 avatar dicarne avatar opaqueglass avatar idea-zone avatar stardustsheep avatar oltermare avatar langyamu avatar wuxiaofei01 avatar sanly avatar

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.