INTEGRACIONES
GitHub
Código personalizado y fragmentos de código con GitHub
4 min
la integración con github te permite sincronizar el docid\ apdlea7hzlsy3wvnd4yp4 docid 29mgmixagtuisxpyayirx , customjs , footertemplate , headertemplate , directamente desde el repositorio de github estas variables pueden ser texto sin formato o enlaces a un archivo de la raíz carpeta solo necesitas definir el archbee json archivo en tu repositorio y agregar tu código personalizado o css personalizado, como en este ejemplo archbee json { "root" "docfolderwithsummary", "structure" { "summary" "summary md", "assets" " archbee/assets" }, "customjs" "custom js", "customcss" " \n { font family \\"comic sans ms\\", cursive, sans serif; }", "footertemplate" "", "headerincludes" "" } summary md # table of contents \ \[introduction]\(introduction md) \## walkthroughs \ \[installing]\(walkthroughs/01 installing app md) \ \[adding event handlers]\(walkthroughs/02 adding event handlers md) \ \[defining custom elements]\(walkthroughs/03 defining custom elements md) \## docs \ \[configuring]\(docs/01 configuring app md) \ \[adding info]\(docs/02 adding info md) \ \[starting app ]\(docs/03 starting app md) custom js window archbee = window archbee || { queue \[], push function (x) {window archbee queue push(x)} }; window archbee push({ eventtype "init", spaceid "published 0auu0nj zflc52lh2yy5u", }); si subes el código a github, archbee leerá la configuración del archivo archbee json y actualizará automáticamente la sección configuración del espacio > código personalizado fragmentos de código puedes agregar fragmentos de código en tu repositorio de github, solo necesitas configurarlos en el config md archivo el config md archivo debe estar en la misma carpeta que el summary md archivo a continuación se muestra un ejemplo de un config md 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 tienes el siguiente package json archivo (del ejemplo anterior) y también el config md archivo config md ## specify syntax, from and to parameters explicitly \ use{file="swagger v2 json" from="90" to="127" syntax="javascript"} verás 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"] } ] },
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.