Mukautettu koodi ja koodinpätkät GitHubin kanssa

4 min

Integrointi GitHubin kanssa antaa mahdollisuuden synkronoida Mukautettu koodi:n mukautettuCSS, customJS, footerTemplate, headerTemplate, suoraan GitHub-repositoriosta. Nämä muuttujat voivat olla raakatekstiä tai linkittää tiedostoon juuri-kansiosta.

Sinun tarvitsee vain määrittää archbee.json -tiedosto repositoriossasi ja lisätä mukautettu koodi tai mukautettu CSS, kuten tässä esimerkissä:

{
  "root": "docfolderwithsummary",
  "structure": {
    "summary": "summary.md",
    "assets": ".archbee/assets"
  },
  "customJS":"custom.js",
  "customCSS":"* \n {  font-family: \"Comic Sans MS\", cursive, sans-serif; }",
  "footerTemplate": "",
  "headerIncludes": ""
}

Jos pushaat koodin GitHubiin, Archbee lukee määrityksen archbee.json-tiedostosta ja päivittää automaattisesti Avaruusasetukset -> Mukautettu koodi -osion uudella koodillasi.

Mukautettu koodi Space settingsissä

Koodikatkelmat

Voit lisätä koodikatkelmia GitHub-repositorioosi, sinun tarvitsee vain määrittää ne config.md-tiedostossa.

Tiedosto config.md on sijoitettava samaan kansioon kuin tiedosto yhteenveto.md.

Alla on esimerkki config.md-tiedostosta:

## 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"}

Esimerkki

Oletetaan, että sinulla on alla oleva package.json-tiedosto (yllä olevasta esimerkistä):

Esimerkki koodikatkelmasta

Ja myös config.md-tiedosto:

## specify syntax, from and to parameters explicitly
::use{file="swagger-v2.json" from="90" to="127" syntax="javascript"}

Näet seuraavan Archbee-dokumentissa tuonnin jälkeen:

      "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.