https://github.com/mizukisonoko/jsoneon
https://github.com/mizukisonoko/jsoneon
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mizukisonoko/jsoneon
- Owner: MizukiSonoko
- Created: 2016-03-31T08:08:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-04-23T12:31:01.000Z (about 9 years ago)
- Last Synced: 2025-01-15T06:53:20.311Z (5 months ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jsoneon
[](https://badge.fury.io/js/gitbook-plugin-jsoneon)
# Install
In book.json
```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
```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 %}
```