You can add code snippets in your GitHub repo, by configuring them in the config.md file. The config.md file should be in the same folder as summary.md Below is an example of a config.md file:
## use a file relative to docsPath folder ::use{file="swagger-v2.json#L2"} ## relative path to repo structure ::use{file="/app/package.json#L1-L5"} ## relative path to docsPath folder ::use{file="../app/package.json#L1-L5"} ## one single line ::use{file="../app/package.json#L5"} ## specify syntax, from and to parameters explicitly ::use{file="swagger-v2.json" from="L6" to="L10" syntax="javascript"}
Assuming that you have the bellow package.json file(from the above example)
And you have the below config.md:
## specify syntax, from and to parameters explicitly ::use{file="swagger-v2.json" from="90" to="127" syntax="javascript"}
After you import, you will see this in the Archbee doc:
"post": { "tags": ["pet"], "summary": "Add a new pet to the store", "description": "", "operationId": "addPet", "consumes": ["application/json", "application/xml"], "produces": ["application/json", "application/xml"], "parameters": [ { "in": "body", "name": "body", "description": "Pet object that needs to be added to the store", "required": true, "schema": { "$ref": "#/definitions/Pet" } } ], "responses": { "200": { "description": "Success!" }, "405": { "description": "Invalid input" } }, "security": [ { "api_key": [] }, { "petstore_auth": ["write:pets", "read:pets"] } ] },
