Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 891 Bytes

README.md

File metadata and controls

23 lines (18 loc) · 891 Bytes

Contains information/code for different card types

Structure of a repo:

  • README.md - this file
  • types - directory to keep all card types Each card-type should be presented in form:
  1. Separate directory with card-type name
  2. REAMDE.md file which explains the main purpose of type. Screenshots with examples and so on
  3. example.json5 - example card, described according to the card type
  4. validator.js - file, which should provide validation function, exported by default (in commonjs modules format), which should return true/false for incoming object. Better to use json-schema validation.
  5. index.js - file, which converts incoming object (like from example.json5) to structure. Should provide the single function as default export (commonjs modules format).
{
  front: {(html)String},
  back: {(html)String},
  tags: {String[]}
}