{"_id":"graphqldoc","_rev":"4-afa367da4817c62eaf018e129fb6eaa4","name":"graphqldoc","dist-tags":{"latest":"2.5.2"},"versions":{"2.4.1":{"name":"graphqldoc","version":"2.4.1","description":"Generate GraphQL docs from schema.","main":"bin/graphqldoc","bin":{"graphqldoc":"./bin/graphqldoc.js"},"scripts":{"sass":"node-sass --output-style compressed template/slds/styles/graphdoc.scss > template/slds/styles/graphdoc.css","compile":"tsc -p .","declaration":"tsc -d -p tsconfig.json","doc.github":"node bin/graphqldoc.js -c example.github.json -f -v","doc.pokemon":"node bin/graphqldoc.js -c example.pokemon.json -f -v","doc.shopify":"node bin/graphqldoc.js -c example.shopify.json -f -v","doc.starwars":"node bin/graphqldoc.js -c example.starWars.json -f -v","doc.starwars-js":"node bin/graphqldoc.js -c example.starWars-js.json -f -v","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/menewman/graphqldoc.git"},"keywords":["graphql","graphdoc","graphqldoc","docs","documentation"],"author":{"name":"Michael Newman","email":"michaeleugenenewman@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/menewman/graphqldoc/issues"},"homepage":"https://github.com/menewman/graphqldoc#readme","devDependencies":{"@salesforce-ux/design-system":"2.2.1","@types/bluebird":"~3.0.0","@types/chai":"^3.4.34","@types/fs-extra":"0.0.32","@types/glob":"^5.0.30","@types/graphql":"^0.8.6","@types/jest":"^18.1.0","@types/marked":"0.0.27","@types/mocha":"^2.2.32","@types/mustache":"^0.8.28","@types/node":"^10.14.4","@types/request":"^2.48.1","chai":"^3.5.0","handlebars":"^4.0.10","jest":"^18.1.0","node-sass":"^3.8.0","typescript":"~2.3.0"},"dependencies":{"@2fd/command":"^1.1.2","bluebird":"^3.5.0","deepmerge":"^3.2.0","fs-extra":"^0.30.0","glob":"^7.1.0","graphql":"^0.7.0","marked":"^0.3.6","mustache":"^2.2.1","request":"^2.79.0","slug":"^0.9.1","striptags":"^3.1.1","word-wrap":"^1.2.1"},"gitHead":"dcd64a5c655787c05ff1f709f4196374e8088b8a","_id":"graphqldoc@2.4.1","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"daudadagr","email":"michaeleugenenewman@gmail.com"},"dist":{"integrity":"sha512-PB4tMEQdvoaOfsKYETP77nXwai4mYqYZnEyM1Woh5VlYWewBxHjK6O3VXAIrN8g7p87tvDqge735af5PV9vd/Q==","shasum":"f967fb8eaa303697f9568af49a5a147994d859b1","tarball":"https://registry.npmjs.org/graphqldoc/-/graphqldoc-2.4.1.tgz","fileCount":705,"unpackedSize":35411565,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcmZawCRA9TVsSAnZWagAAip4P+wZJ2gPNI1+pFYbYSU5o\n9kg8eDHh3jxk3pmoNdQZ4s6BRNBEByhn7GflEJp8qhPd4EqdTey/1RMrgt+v\nVhH3qZyQ2QICfPdrqjsTlO7oHGRlwPHP+4Ighd7bh/4XypaNIRiWxnM2OCrO\nDWBRT1XAonesr/7EOqJqrfM2NrkmOjSQjYq/SupA4IyBwST8rojJn3TSXSDi\nAGBRCoknl5avsLFyE6Si7NqlqQLBCUYPl1MxBqkylsDxweAPOGiEThSqCMW2\n2E/cBUrnwwy2YcgREPzR/RoyyzBFkceXX2mY4bARVKOymNRsBz7FfAf0ZFCu\nx7agTMTM0Ed/wRpRjgyaYMsQeSVVQ5aM4aSp4w45w4ERhCmJzznQtG2XYO/b\ndvYMbFH6XSHRO8Iy9r5z9KiFpE4psB71SiQiNBuDAfb1dkq/NjtpW/+5EQcO\nsua5AngSrilpaVySi4B/g6nYTmQQpY8mLdNI34RcCEGkBPk5a+71YZ4WvQnt\nEwX/A+1BjTvJEvTN0aINqYscYT1yNcGIEwl8RTN7UM9+KrTfL3lVZEldb+zR\nFpQK0mOi/ZEkQpNqllr2QTDatzZ5teYzPzs6sPnucQf0PNtlgSqi3Xu+qXdW\no8nWQYU14l71pUn9vRlhnuzssnzGsPS9RL9vbfYuIAVORpmHTSDcCiAf/ydI\n0YCc\r\n=WWg1\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDkCQs0EcetI82vz3yYAwgeDNRHYutsz4iLKgCP7O9GgwIgTxIl0DWYYyMbOYGEWKrVaG9K+snscPZ6beqYDSoE9Po="}]},"maintainers":[{"name":"daudadagr","email":"michaeleugenenewman@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/graphqldoc_2.4.1_1553569455197_0.9536984765096195"},"_hasShrinkwrap":false},"2.5.0":{"name":"graphqldoc","version":"2.5.0","description":"Generate GraphQL docs from schema.","main":"bin/graphqldoc","bin":{"graphqldoc":"./bin/graphqldoc.js"},"scripts":{"sass":"node-sass --output-style compressed template/slds/styles/graphdoc.scss > template/slds/styles/graphdoc.css","compile":"tsc -p .","declaration":"tsc -d -p tsconfig.json","doc.github":"node bin/graphqldoc.js -c example.github.json -f -v","doc.pokemon":"node bin/graphqldoc.js -c example.pokemon.json -f -v","doc.shopify":"node bin/graphqldoc.js -c example.shopify.json -f -v","doc.starwars":"node bin/graphqldoc.js -c example.starWars.json -f -v","doc.starwars-js":"node bin/graphqldoc.js -c example.starWars-js.json -f -v","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/CodeSignal/graphqldoc.git"},"keywords":["graphql","graphdoc","graphqldoc","docs","documentation"],"license":"MIT","bugs":{"url":"https://github.com/CodeSignal/graphqldoc/issues"},"homepage":"https://github.com/CodeSignal/graphqldoc#readme","devDependencies":{"@salesforce-ux/design-system":"^2.8.3","@types/bluebird":"^3.5.26","@types/chai":"^4.1.7","@types/fs-extra":"^5.0.5","@types/glob":"^7.1.1","@types/graphql":"^14.0.7","@types/jest":"^24.0.11","@types/marked":"^0.6.3","@types/mocha":"^5.2.6","@types/mustache":"^0.8.28","@types/node":"^11.11.7","@types/request":"^2.48.1","chai":"^4.2.0","handlebars":"^4.0.10","jest":"^24.5.0","node-sass":"^4.11.0","ts-jest":"^24.0.0","typescript":"^3.3.4000"},"dependencies":{"@2fd/command":"^1.1.2","bluebird":"^3.5.0","deepmerge":"^3.2.0","fs-extra":"^7.0.1","glob":"^7.1.0","graphql":"^14.1.1","marked":"^0.6.1","mustache":"^3.0.1","request":"^2.79.0","slug":"^1.0.0","striptags":"^3.1.1","word-wrap":"^1.2.1"},"gitHead":"0f8a34730b8d8c74e511026eb7ed0c93825c9de1","_id":"graphqldoc@2.5.0","_npmVersion":"6.4.1","_nodeVersion":"10.14.2","_npmUser":{"name":"daudadagr","email":"michaeleugenenewman@gmail.com"},"dist":{"integrity":"sha512-fgkcKX1CjxO6b7/PHmWs9cUZFWPdeDiHs5ogi8NO1nvJFYL3/iul6v6FifAN3Ou6WF4yDg7JKjSMnMX40gjp8Q==","shasum":"500f088cf349b8a2960e1285be80a58d317cf64e","tarball":"https://registry.npmjs.org/graphqldoc/-/graphqldoc-2.5.0.tgz","fileCount":168,"unpackedSize":5286364,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcmeKkCRA9TVsSAnZWagAArHEP/1HgY44gb9DaTK4n5WT7\n0kjcHHjzvuGCTgAp+dYQumtXCpeLIvr9j4p3YkSIZp2ZQzzk6ynUeTD6d+mk\nXp2Dlo91HSDT5QFvftd745kDWb0gv6q7Zc4a+qfemNqr7559eoyjSJHmOBee\nWbcyn+2a6h24KBZh93L58UMlANesfpeVTc+/HP2tkpxM5HZZzyUbZDIEPMYc\n3ZdK3mMW/9CS1vKOXzddoazEaa3KqbnPKZLcZ5XoGDjiYmV+8Lz5VDywiRZO\nFsA4zIfQ28iLJVS4J20H/GY01BtgcogIdKTVFO0Y2c4AKzY45kfWRNOpV/DF\nTww+mBqDFGRWDb2ts9wVNhJBRvF90o4P2rr2JkCE9CSATRzMDZZBV0b9n/HN\n8rv7SINV0PUNyvt6+b3OA/Wn+/LVQic3II6wv3qfbBfPgdlh2Leyq6gQIb7I\nl1Z/8T2hwAj5kS9jY9oQezDOuaedTFPi9FG+S9+g28Ntfmicd9bcBpwk6S1b\n8AjnRoQck/uq1d0LNKisato4HV4QdRqtuTGIZ8kUaOn7gg9EQcIhpbF/eefP\nrNWJ2QoedBQ8mhErijuRPjWc3H19DNz59gAynZ+Cao6qgB0zvV9N0He0w4Im\nDfJA1hMuJAXpblsjq/0eLNMtK0p3lrP2yAh8InX+gMl09ii3aqWexOmwqpJV\nNgc0\r\n=NHIB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC5ab65XF9Djz9oWfrpkEVGCdt7T3v2+DZfk7phr71sPAiEA9QK9qgahQfuyytatrOWIZAzuGI+usUz9WJjXIQW9VvY="}]},"maintainers":[{"name":"daudadagr","email":"michaeleugenenewman@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/graphqldoc_2.5.0_1553588899950_0.7218518074836744"},"_hasShrinkwrap":false},"2.5.1":{"name":"graphqldoc","version":"2.5.1","description":"Generate GraphQL docs from schema.","main":"bin/graphqldoc","bin":{"graphqldoc":"./bin/graphqldoc.js"},"scripts":{"sass":"node-sass --output-style compressed template/slds/styles/graphdoc.scss > template/slds/styles/graphdoc.css","compile":"tsc -p .","declaration":"tsc -d -p tsconfig.json","doc.github":"node bin/graphqldoc.js -c example.github.json -f -v","doc.pokemon":"node bin/graphqldoc.js -c example.pokemon.json -f -v","doc.shopify":"node bin/graphqldoc.js -c example.shopify.json -f -v","doc.starwars":"node bin/graphqldoc.js -c example.starWars.json -f -v","doc.starwars-js":"node bin/graphqldoc.js -c example.starWars-js.json -f -v","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/CodeSignal/graphqldoc.git"},"keywords":["graphql","graphdoc","graphqldoc","docs","documentation"],"license":"MIT","bugs":{"url":"https://github.com/CodeSignal/graphqldoc/issues"},"homepage":"https://github.com/CodeSignal/graphqldoc#readme","devDependencies":{"@salesforce-ux/design-system":"^2.8.3","@types/bluebird":"^3.5.26","@types/chai":"^4.1.7","@types/fs-extra":"^5.0.5","@types/glob":"^7.1.1","@types/graphql":"^14.0.7","@types/jest":"^24.0.11","@types/marked":"^0.6.3","@types/mocha":"^5.2.6","@types/mustache":"^0.8.28","@types/node":"^11.11.7","@types/request":"^2.48.1","chai":"^4.2.0","handlebars":"^4.0.10","jest":"^24.5.0","node-sass":"^4.11.0","ts-jest":"^24.0.0","typescript":"^3.3.4000"},"dependencies":{"@2fd/command":"^1.1.2","bluebird":"^3.5.0","deepmerge":"^3.2.0","fs-extra":"^7.0.1","glob":"^7.1.0","graphql":"^14.1.1","marked":"^0.6.1","mustache":"^3.0.1","request":"^2.79.0","slug":"^1.0.0","striptags":"^3.1.1","word-wrap":"^1.2.1"},"gitHead":"1caf23862cae4283f604fce5bed524566b46c780","_id":"graphqldoc@2.5.1","_npmVersion":"6.4.1","_nodeVersion":"10.14.2","_npmUser":{"name":"daudadagr","email":"michaeleugenenewman@gmail.com"},"dist":{"integrity":"sha512-WMPIU13jQNOiBluxdS3ulEcnSeEFIe8EhKkcrcl4Hql6uZB9yerCw5z+Pviyc+eKRSRY1UWXR53C6clEGTKCFw==","shasum":"3d18230c12893b89e63ed13813841558df39f602","tarball":"https://registry.npmjs.org/graphqldoc/-/graphqldoc-2.5.1.tgz","fileCount":168,"unpackedSize":5286393,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcmeUGCRA9TVsSAnZWagAAal0QAI3/nmyRZbhR174dpJHm\nnVnhnyGpET/VlI5XHK8JFmVK2rSHI95T4CCxPmpiDpSsbKu6HqcB3TuUpSMB\nN+GI29uVNQky1i7Nuu7T8uA1G4sDgFeawysi12g4kq0+A1tT4GPJmNWTg49u\nExho49urj3lloZ9d/LvYpvzWNdPvKZUlnG3zsD6+5Ofp7T0qqKGwNObCYMzw\nb+OFxQoFrHmEx2mmnKlbT5eVz3bhMw3goInY4MiPpujnvM76Osmd0y1qIWgx\nHDM9KC/e80zzxbOyDOGcxlsiIeHpXzqrx9+hr2yjbGm+0bPzMsgDBOmESxAr\nCEWM508O/ChQW6AwQ+5QTx6gdmyb55xZl94JPYCIaEx1EOKOnplAHUZD1P8j\nN0FD0poa3Hgmty3bFotRqpkKpKQDPWvNxgnocdvIywumWODmBOiYEHfbWO9N\nbjv0wKajl+hubYb2/EWL1AU7FVSYQsyjsERrQ7p4WR5+IeQyP/+tljmz+EJ0\nKk/UjIYGnxewYaR6166tFxqgpVr270tKjQG3lOcF3zcmze8n6ZuSsg1Lnf40\nlIWXTZOlopb1qrMXkQrfMwas879RF1oGwT8MGKWqieBcY/QgdxccB+tZLY5S\nG005F6+ncCPt5WO5srLVaAJAywthkgXmsEBZKcdKLMa2FJa3+Xb59Hzc62G/\nuYW2\r\n=2BoQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGTdjgwM0mE5OkhG/QGexlzdSk2w1h+KS9ADXRvgaSXUAiEA6tok1vB4eaY+LSfuXwWjFx2j7UKqlVAXMHGXf37+T3A="}]},"maintainers":[{"name":"daudadagr","email":"michaeleugenenewman@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/graphqldoc_2.5.1_1553589509699_0.27499796289165723"},"_hasShrinkwrap":false},"2.5.2":{"name":"graphqldoc","version":"2.5.2","description":"Generate GraphQL docs from schema.","main":"bin/graphqldoc","bin":{"graphqldoc":"./bin/graphqldoc.js"},"scripts":{"sass":"node-sass --output-style compressed template/slds/styles/graphdoc.scss > template/slds/styles/graphdoc.css","compile":"tsc -p .","declaration":"tsc -d -p tsconfig.json","doc.github":"node bin/graphqldoc.js -c example.github.json -f -v","doc.pokemon":"node bin/graphqldoc.js -c example.pokemon.json -f -v","doc.shopify":"node bin/graphqldoc.js -c example.shopify.json -f -v","doc.starwars":"node bin/graphqldoc.js -c example.starWars.json -f -v","doc.starwars-js":"node bin/graphqldoc.js -c example.starWars-js.json -f -v","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/CodeSignal/graphqldoc.git"},"keywords":["graphql","graphdoc","graphqldoc","docs","documentation"],"license":"MIT","bugs":{"url":"https://github.com/CodeSignal/graphqldoc/issues"},"homepage":"https://github.com/CodeSignal/graphqldoc#readme","devDependencies":{"@salesforce-ux/design-system":"^2.8.3","@types/bluebird":"^3.5.26","@types/chai":"^4.1.7","@types/fs-extra":"^5.0.5","@types/glob":"^7.1.1","@types/graphql":"^14.0.7","@types/jest":"^24.0.11","@types/marked":"^0.6.3","@types/mocha":"^5.2.6","@types/mustache":"^0.8.28","@types/node":"^11.11.7","@types/request":"^2.48.1","chai":"^4.2.0","handlebars":"^4.0.10","jest":"^24.5.0","node-sass":"^4.11.0","ts-jest":"^24.0.0","typescript":"^3.3.4000"},"dependencies":{"@2fd/command":"^1.1.2","bluebird":"^3.5.0","deepmerge":"^3.2.0","fs-extra":"^7.0.1","glob":"^7.1.0","graphql":"^14.1.1","marked":"^0.6.1","mustache":"^3.0.1","request":"^2.79.0","slug":"^1.0.0","striptags":"^3.1.1","word-wrap":"^1.2.1"},"gitHead":"ba87f36c83c933e8e418616227a94d408e08ee7c","_id":"graphqldoc@2.5.2","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"daudadagr","email":"michaeleugenenewman@gmail.com"},"dist":{"integrity":"sha512-a8MQIHLVJelPUzwtUjzCjRa3xa2c8K16peGAvgzWRDhdpWV+2YQNfRyxB8NHamojf8A2TCpGAV6MZvQgiziuyA==","shasum":"f1954b6c1479ec9bec034b2d0c6bd72c63889fb2","tarball":"https://registry.npmjs.org/graphqldoc/-/graphqldoc-2.5.2.tgz","fileCount":168,"unpackedSize":5292434,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcm/CXCRA9TVsSAnZWagAAFCoQAJ83GudrVIGZ7iJTbwEd\nZv9BDkjvQlR2r5eJzHea+wOdhdh4h86gUe5VGmxpSquzDwonWo58L1qkpCiv\nu7Q+oszaGsLQRULoWCFlkkiBkk+AizFmTo2FNw2Yx7VYoETfipZKr8gCy/4v\nnijtvfW325tNPJitAyeW0yWyDpQQu8wF+gwJsh38HxbfhsssVE4eF7PMnaYr\nDs9KZDRyOdImtOv8/MjUF/tw6zd5ds54AEVGvVahQNTMK8b4UQiLOXrD8i27\n1UO/mgDYDUV342lPeTbhNKZXQ/J/mq3KRtTlL08wU32b/T5r5fezqKO5MrgR\nk1e/Hmy4SdBncmeTBp6EsSLlz7Tz1q5xjjXu5+i4yY7S/bBAkNyxw4pYcfSH\nAJfeKGZyoV70t+FyoFOumd/6YXlZOaSMBdtcHjWxvnYmAu6793DODZ/4v4p3\nrF2mR1xZNeEvjMVZPJXV2vHuJdhcu/OJzVOtvBTacLylPl3voSyF1iZIa5DX\nk9LJiAEkeJZyXCEtRAzKZpNI6gRe3He2MhYpLosDpofciv7kEJY4GS7zrG1k\nqN2yqOWkXdMDn6oGf+wDTJuUUbaNcYvHcesX48pbo3Njo1IkZRBQWmSSwffW\nnWs0bI31zjhR+lw06OElvEumc3rNkMprYG6aBrvsfiac1bSsa6FumTdBhRwV\n/DMS\r\n=Z/FK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDViOhK0Gw5hoIXsVu08Y38ZMbJunVXyD9FooLVxu/d/AiEAucyBj/O5nA+bGyfWf7PHUPpg2+gMtD8gQmJJEE/TKyQ="}]},"maintainers":[{"name":"daudadagr","email":"michaeleugenenewman@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/graphqldoc_2.5.2_1553723542308_0.17363475844342702"},"_hasShrinkwrap":false}},"time":{"created":"2019-03-26T03:04:15.197Z","2.4.1":"2019-03-26T03:04:15.604Z","modified":"2022-05-04T03:26:06.281Z","2.5.0":"2019-03-26T08:28:20.378Z","2.5.1":"2019-03-26T08:38:29.953Z","2.5.2":"2019-03-27T21:52:22.474Z"},"maintainers":[{"name":"daudadagr","email":"michaeleugenenewman@gmail.com"}],"description":"Generate GraphQL docs from schema.","homepage":"https://github.com/CodeSignal/graphqldoc#readme","keywords":["graphql","graphdoc","graphqldoc","docs","documentation"],"repository":{"type":"git","url":"git+https://github.com/CodeSignal/graphqldoc.git"},"bugs":{"url":"https://github.com/CodeSignal/graphqldoc/issues"},"license":"MIT","readme":"# Generate GraphQL docs from schema.\n\n* [install](#install)\n* [use](#use)\n* [plugin](#plugin)\n\nForked from the excellent but unfortunately unmaintained [graphdoc package](https://github.com/2fd/graphdoc).\n\n## Install\n\nTo install globally:\n```bash\n    npm install -g graphqldoc\n```\n\n## Use\n\n### Generate documentation from live endpoint\n\n```bash\n    > graphqldoc -e http://localhost:8080/graphql -o ./doc/schema\n```\n\n### Generate documentation from IDL file\n\n```bash\n    > graphqldoc -s ./schema.graphql -o ./doc/schema\n```\n\n### Generate documentation from for the [\"modularized schema\"](http://dev.apollodata.com/tools/graphql-tools/generate-schema.html#modularizing) of graphql-tools\n\n```bash\n    > graphqldoc -s ./schema.js -o ./doc/schema\n```\n\n> `./schema.graphql` must be able to be interpreted with [graphql-js/utilities#buildSchema](http://graphql.org/graphql-js/utilities/#buildschema)\n\n\n### Generate documentation from json file\n\n```bash\n    > graphqldoc -s ./schema.json -o ./doc/schema\n```\n\n> `./schema.json` contains the result of GraphQL introspection query.\n\n### Puts the options in your `package.json`\n\n```javascript\n     // package.json\n\n    {\n        \"name\": \"project\",\n        // [...]\n        \"graphqldoc\": {\n            \"endpoint\": \"http://localhost:8080/graphql\",\n            \"output\": \"./doc/schema\",\n        }\n    }\n```\n\nAnd execute\n\n```bash\n    > graphqldoc\n```\n\n### Help\n\n```bash\n\n    > graphqldoc -h\n    \n    \u001b\u001bStatic page generator for documenting GraphQL Schema v2.4.0\n\n    \u001bUsage: node bin/graphqldoc.js [OPTIONS] \n\n    \u001b\n    \u001b\u001b[OPTIONS]:\n    \u001b\u001b-c, --config                   \u001bConfiguration file [./package.json].\n    \u001b\u001b-e, --endpoint                 \u001bGraphql http endpoint [\"https://domain.com/graphql\"].\n    \u001b\u001b-x, --header                   \u001bHTTP header for request (use with --endpoint). [\"Authorization: Token cb8795e7\"].\n    \u001b\u001b-q, --query                    \u001bHTTP querystring for request (use with --endpoint) [\"token=cb8795e7\"].\n    \u001b\u001b-s, --schema, --schema-file    \u001bGraphql Schema file [\"./schema.json\"].\n    \u001b\u001b-p, --plugin                   \u001bUse plugins [default=graphqldoc/plugins/default].\n    \u001b\u001b-t, --template                 \u001bUse template [default=graphqldoc/template/slds].\n    \u001b\u001b-o, --output                   \u001bOutput directory.\n    \u001b\u001b-d, --data                     \u001bInject custom data.\n    \u001b\u001b-b, --base-url                 \u001bBase url for templates.\n    \u001b\u001b-f, --force                    \u001bDelete outputDirectory if exists.\n    \u001b\u001b-v, --verbose                  \u001bOutput more information.\n    \u001b\u001b-V, --version                  \u001bShow graphqldoc version.\n    \u001b\u001b-h, --help                     \u001bPrint this help\n\u001b\n\n```\n\n## Plugin\n\nIn graphqldoc a plugin is simply an object that controls the content that is displayed\non every page of your document.\n\nThis object should only implement the [`PluginInterface`](https://github.com/CodeSignal/graphqldoc/blob/master/lib/interface.d.ts#L12-L117).\n\n### Make a Plugin\n\nTo create your own plugin you should only create it as a `plain object`\nor a `constructor` and export it as `default`\n\nIf you export your plugin as a constructor, when going to be initialized,\nwill receive three parameters\n\n* `schema`: The full the result of GraphQL instrospection query.\n* `projectPackage`: The content of `package.json` of current project (or the content of file defined with `--config` flag).\n* `graphqldocPackage`: The content of `package.json` of graphqldoc.\n\n> For performance reasons all plugins receive the reference to the same object\n> and therefore should not modify them directly as it could affect the behavior\n> of other plugins (unless of course that is your intention)\n\n#### Examples\n\n```typescript\n\n    // es2015 export constructor\n    export default class MyPlugin {\n        constructor(schema, projectPackage, graphqldocPackage){}\n        getAssets() { /* ... */ }\n        /* ... */\n    }\n\n```\n\n```typescript\n    // es2015 export plain object\n    export default cost myPlugin = {\n        getAssets() { /* ... */ },\n        /* ... */\n    }\n```\n\n```javascript\n\n    // export constructor\n    function MyPlugin(schema, projectPackage, graphqldocPackage) { /* ... */ }\n\n    MyPlugin.prototype.getAssets =  function() { /* ... */ };\n    /* ... */\n\n    exports.default = MyPlugin;\n```\n\n```javascript\n\n    // export plain object\n\n    exports.default = {\n        getAssets: function() { /* ... */ },\n        /* ... */\n    }\n\n```\n\n### Use plugin\n\nYou can use the plugins in 2 ways.\n\n\n#### Use plugins with command line\n\n```bash\n    > graphqldoc  -p graphqldoc/plugins/default \\\n                -p some-dependencie/plugin \\\n                -p ./lib/plugin/my-own-plugin \\\n                -s ./schema.json -o ./doc/schema\n```\n\n#### Use plugins with `package.json`\n\n```javascript\n     // package.json\n\n    {\n        \"name\": \"project\",\n        // [...]\n        \"graphqldoc\": {\n            \"endpoint\": \"http://localhost:8080/graphql\",\n            \"output\": \"./doc/schema\",\n            \"plugins\": [\n                \"graphqldoc/plugins/default\",\n                \"some-dependencie/plugin\",\n                \"./lib/plugin/my-own-plugin\"\n            ]\n        }\n    }\n```\n","readmeFilename":"README.md"}