Benutzerdefinierter Code und Code-Snippets mit GitHub
Die Integration mit GitHub ermöglicht es Ihnen, die Benutzerdefinierter Code: customCSS, customJS, footerTemplate, headerTemplate, direkt aus dem GitHub-Repository zu synchronisieren. Diese Variablen können Rohtext sein oder auf eine Datei aus dem Wurzel Ordner verlinken.
Sie müssen lediglich die archbee.json Datei in Ihrem Repository definieren und Ihren benutzerdefinierten Code oder benutzerdefiniertes CSS hinzufügen, wie in diesem Beispiel:
{
"root": "docfolderwithsummary",
"structure": {
"summary": "summary.md",
"assets": ".archbee/assets"
},
"customJS":"custom.js",
"customCSS":"* \n { font-family: \"Comic Sans MS\", cursive, sans-serif; }",
"footerTemplate": "",
"headerIncludes": ""
}Wenn Sie den Code auf GitHub pushen, liest Archbee die Konfiguration aus der archbee.json Datei und aktualisiert automatisch den Abschnitt Space Einstellungen -> Benutzerdefinierter Codemit Ihrem neuen Code.
Code-Snippets
Sie können Code-Snippets in Ihrem GitHub-Repository hinzufügen, Sie müssen sie nur in der config.md Datei konfigurieren.
Die config.md Datei muss im selben Ordner platziert werden wie die summary.md Datei.
Unten finden Sie ein Beispiel für eine config.md Datei:
## 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"}
Beispiel
Angenommen, Sie haben die folgende package.json Datei (aus dem obigen Beispiel):
Und außerdem die config.md Datei:
## specify syntax, from and to parameters explicitly
::use{file="swagger-v2.json" from="90" to="127" syntax="javascript"}
Nach dem Import sehen Sie Folgendes im Archbee-Dokument:
"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"]
}
]
},