Pasgemaakte kode & kodebrokkies met GitHub
Integrasie met GitHub laat u toe om die Pasgemaakte kode: customCSS, customJS, footerTemplate, headerTemplate, direk vanaf die GitHub repository te sinkroniseer. Hierdie veranderlikes kan rou teks wees of na 'n lêer vanaf die wortel gids skakel.
U hoef net die archbee.json lêer in u repo te definieer en u pasgemaakte kode of pasgemaakte CSS by te voeg, soos in hierdie voorbeeld:
{
"root": "docfolderwithsummary",
"structure": {
"summary": "summary.md",
"assets": ".archbee/assets"
},
"customJS":"custom.js",
"customCSS":"* \n { font-family: \"Comic Sans MS\", cursive, sans-serif; }",
"footerTemplate": "",
"headerIncludes": ""
}As u die kode na GitHub push, sal Archbee die konfigurasie vanaf die archbee.json lêer lees en die Ruimte-instellings -> Pasgemaakte kode afdeling outomaties met u nuwe kode opdateer.
Kodebrokkies
U kan kodebrokkies in u GitHub repo byvoeg, u hoef dit net in die config.md lêer te konfigureer.
Die config.md lêer moet in dieselfde gids as die summary.md lêer geplaas word.
Hieronder is 'n voorbeeld van 'n config.md lêer:
## 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"}
Voorbeeld
Gestel dat u die onderstaande package.json lêer het (van die bogenoemde voorbeeld):
En ook die config.md lêer:
## specify syntax, from and to parameters explicitly
::use{file="swagger-v2.json" from="90" to="127" syntax="javascript"}
U sal die volgende in die Archbee dokument sien na die invoer:
"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"]
}
]
},