Código personalizado y fragmentos de código con GitHub
La integración con GitHub le permite sincronizar el Código Personalizado: customCSS, customJS, footerTemplate, headerTemplate, directamente desde el repositorio de GitHub. Estas variables pueden ser texto sin formato o un enlace a un archivo desde la carpeta raíz.
Solo necesita definir el archivo archbee.json en su repositorio y agregar su código personalizado o CSS personalizado, como en este ejemplo:
{
"root": "docfolderwithsummary",
"structure": {
"summary": "summary.md",
"assets": ".archbee/assets"
},
"customJS":"custom.js",
"customCSS":"* \n { font-family: \"Comic Sans MS\", cursive, sans-serif; }",
"footerTemplate": "",
"headerIncludes": ""
}Si envía el código a GitHub, Archbee leerá la configuración del archivo archbee.json y actualizará automáticamente la sección Configuraciones de Espacio -> Código Personalizadocon su nuevo código.
Fragmentos de código
Puede agregar fragmentos de código en su repositorio de GitHub, solo necesita configurarlos en el archivo config.md.
El archivo config.md debe colocarse en la misma carpeta que el archivo summary.md.
A continuación se muestra un ejemplo de un archivo config.md:
## 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"}
Ejemplo
Suponiendo que tiene el siguiente archivo package.json (del ejemplo anterior):
Y también el archivo config.md:
## specify syntax, from and to parameters explicitly
::use{file="swagger-v2.json" from="90" to="127" syntax="javascript"}
Verá lo siguiente en el documento de Archbee después de la importación:
"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"]
}
]
},