Benutzerdefinierter Code & Code-Snippets mit GitHub

4 min

Die Integration mit GitHub ermöglicht es Ihnen, den Benutzerdefinierter Code: benutzerdefiniertesCSS, customJS, footerTemplate, headerTemplate, direkt aus dem GitHub-Repository zu synchronisieren. Diese Variablen können Rohtext sein oder auf eine Datei aus dem root-Ordner verweisen.

Sie müssen lediglich die Datei archbee.json in Ihrem Repo definieren und Ihren benutzerdefinierten Code oder Ihr 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 Datei archbee.json und aktualisiert automatisch den Abschnitt Raumeinstellungen -> Benutzerdefinierter Code mit Ihrem neuen Code.

Benutzerdefinierter Code in den Space-Einstellungen

Code-Snippets

Sie können Code-Snippets in Ihrem GitHub-Repo hinzufügen. Sie müssen diese lediglich in der Datei config.md konfigurieren.

Die Datei config.md muss im selben Ordner wie die Datei summary.md platziert werden.

Nachfolgend finden Sie ein Beispiel für eine Datei 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"}

Beispiel

Angenommen, Sie haben die untenstehende Datei package.json (aus dem obigen Beispiel):

Beispiel für ein Code-Snippet

Und außerdem die Datei config.md:

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

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.