Code personnalisé et extraits de code avec GitHub

4 min

L’intégration avec GitHub vous permet de synchroniser le Code personnalisé: customCSS, customJS, footerTemplate, headerTemplate, directement depuis le dépôt GitHub. Ces variables peuvent être du texte brut ou un lien vers un fichier depuis le dossier racine.

Vous devez simplement définir le fichier archbee.json dans votre dépôt et ajouter votre code personnalisé ou votre CSS personnalisé, comme dans cet exemple :

{
  "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 vous poussez le code vers GitHub, Archbee lira la configuration depuis le fichier archbee.json et mettra automatiquement à jour la section Paramètres de l’espace -> Code personnaliséavec votre nouveau code.

Code personnalisé dans Space settings

Extraits de code

Vous pouvez ajouter des extraits de code dans votre dépôt GitHub, vous devez simplement les configurer dans le fichier config.md.

Le fichier config.md doit être placé dans le même dossier que le fichier summary.md.

Voici un exemple de fichier 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"}

Exemple

En supposant que vous avez le fichier package.json ci-dessous (de l’exemple ci-dessus) :

Exemple d’extrait de code

Et aussi le fichier config.md :

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

Vous verrez ce qui suit dans le document Archbee après l’import :

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