Créer une page

Ajoutez un fichier Markdown en tant que nouvelle page dans votre portail.

1. Dans le dépôt de votre API Portal, allez dans le dossier content.
2. Créez un fichier Markdown.
   Le nom du fichier est utilisé pour créer l'URL de la page. Si vous créez un fichier nommé examples.md, la page sera disponible à l'adresse <portal-url>/examples.
3. Ajouter des métadonnées à votre page
   Les métadonnées sont entourées de --- et définissent le titre de la page, ainsi que sa position dans l'en-tête. L'en-tête affiche les pages, dans l'ordre croissant de poids (weight). Si deux pages ont le même poids (weight), elles sont triées par ordre alphabétique. Par défaut, le poids (weight) de la page "Getting started" est configuré à 10. Celui de la page "APIs" est configuré à 20. Si vous ajoutez une page nommée "Examples" avec weight: 20, elle s'affiche après "APIs" dans l'en-tête.

   Exemple

   ---
   title: Examples
   menu:
     main:
       weight: 20
   ---

4. Ajoutez votre contenu sous les métadonnées.
   Pour plus d'informations concernant l'écriture en Markdown, consultez Markdown Guide (en anglais).

   Exemple

   ---
   title: Examples
   menu:
     main:
       weight: 20
   ---
   
   # Examples
   
   ## Fetching a book by title
   
   1. Generate an access token.
   2. Run the following command with the relevant query parameters:
     `curl -X GET -H "Authorization:Basic {userToken}" https://company.com/api/books?title={bookTitle}`
   
   ### Result
   A response containing information about the book is returned. For example, the request `https://company.com/api/books?title=Jane+Eyre` returns the following information:
   ``` json
   [
     {
       "id": "hfp1651869",
       "title": "Jane Eyre",
       "author": "Charlotte Brontë",
       "publisher": "Penguin",
       "isbn": "978-0141441146"
     }
   ]
   ```

   Note InformationsConseil : Si vous souhaitez ajouter des exemples de code dans votre contenu, vous pouvez spécifier le langage après les caractères d'ouverture ``` pour activer la coloration syntaxique.
5. Effectuez un commit de vos modifications.

Résultats

Une fois votre portail déployé, la nouvelle page s'affiche. Dans cet exemple, elle a l'aspect suivant :