Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can also delete the current item in the top right-hand corner using the 'Delete Item' button.

To navigate back one hierarchy level, you can click on the three dots to the left of the symbol and name image-20240328-152107.pngImage Added of the current item.

Create Item

...

To create a new item, select the button in the top right corner 'Create New Item' or the menu item of the same name from the dropdown in the same position.

...

To create the item, click on the 'Create New Item' button.

Edit Item - Markdown

...

If you edit an item of the type 'Markdown', a special markdownediotr is displayed. This editor is divided into two parts. On the left side you can make your entries and use the special control characters for markdown. On the right side you will see an updated and rendered version of your input. You can use the toggle 'Auto Save' to set whether the entries you make on the left should be saved permanently or not. If you deactivate this option, you will have to click on the save button at the bottom of your edit to save your changes permanently.

image-20240328-152956.pngImage Added

You can call up the image management dialog via the 'Image Management' button.

Here you can upload any kind of image. It will be saved until you delete it. Everyone who has access to this API can also see the uploaded image. The maximum size is 2 MB.

Select the image you want to display in the documentation, copy the Markdown snippet that appears below and paste it into your documentation.

Edit Item - Rich Text

With the type rich text you get a graphical editor with which you can easily and conveniently create documentation. You can also use this type to create your documentation in htmlHTML.

A summary of all HTML templates can be found here: CMS Template Library

...

If you want to edit an item of the 'Rich Text' type, you first come to the read only editor. here you can view the current item in its current state. To edit the item, click on the 'Edit' button. The editor then switches to edit mode. In this mode you have many different tools at your disposal, which are known from standard text editing programs. You can edit texts directly in the editor.

...

To insert our predefined HTML templates, you can click on the 'Insert Template' button or on the stamp symbol image-20240328-154725.pngImage Added . This will open another window with all available templates.
If you want to edit the plain HTML you have to click on the source code symbol image-20240328-154702.pngImage Added . This will open another window which displays the complete item as HTML code. Here you can insert new HTML code or edit existing code.

To save your changes, click on the 'Save' button.

Settings - Markdown, Rich Text & Folder

...

Items of the type 'Markdown' or 'Rich Text

...

Settings - Folder

...

Developer Portal

...

' have the same structure as the settings view. The item of type 'Markdown' differs from the other types in the settings view only in that it has no toggle 'Welcome Page of this API'. There are various input fields and toggles in the settings view.

  • Name: Specifies the name of the item, which must be unique.

  • Toggle 'Published': Use this option to specify if this documentation page should be displayed in the developer portal.

  • Toggle 'Welcome Page of this API': Use this option to specify which documentation page should be displayed as the overview page in the developer portal for the corresponding API. Only one documentation can be selected as a welcome page at a time. The last setting overwrites the previous one.

  • Url: The url to the Git repository.

  • Git Credential: The Git credential to log in to the Git repository. The Git credentials can be created in Configuration > Git Credentials.

  • Branch: The branch within the Git repository.

  • Path: The path within the Git repository.

  • Fetch interval: The interval at which the latest version should be checked.