gbjsontable

README

gbJsonTable

Install

In book.json

{
  "plugins": ["jsoneon"],
    "pluginsConfig": {
        "jsoneon": {
            "render" : ["info"]
        }
    }
}

Usage

1 create directory to gitbook directory.

directory name is free.

mkdir json

2 Define elements in foo.json

{
    "meta":{
        "name":"Table name",
        "version":"0.0.1",
        "description":"This is table sample.",
        "type":"RDB"
    },
    "elements":{
        "textext" : {
            "type":"text",
             "description":"cappuccino",
            "isOptional" : false,
            "sample":"cappuccino",
            "tag" : ["deprecated", "primary key"]
        },
        "numnum" : {
            "type":"number",
             "description":"IIV",
            "isOptional" : false,
            "sample": 6000,
            "tag" : ["deprecated"]
        },
      "dicdict" : {
            "type":"dictionary",
            "description":"cafe",
            "isOptional" : true,
            "members": {
                    "cco": {
                        "type":"text",
                        "description":"ChiefCoffeeOfficer",
                        "isOptional":false,
                        "sample":"chino",
                        "tag":[]
                    },
                    "cfo" : {
                        "type":"text",
                        "description":"ChiefFriendOfficer",
                        "isOptional":false,
                        "sample":"cocoa",
                        "tag":[]
                    }
            }
        }
    }
}

3 Write in bar.md

{% jsoneon src="json/foo.json" %}
{% endjsoneon %}

Plugin

This is table creating GitBook plugin

https://github.com/sysuzhang/gbJsonTable#readme


Latest: 0.1.0

0.1.0,

Requirements

GitBook
0.1.0 *

Maintainers

Open on NPM