Manage Wiki Documents in API Hub

As a Portal Admin, you can publish markdown content as generic documents to your tenant in API Hub for all users to consume. You can add wiki documents in the languages that API Hub supports.
The following procedures describe how to manage wiki documents by way of API Hub. You can also manage wiki documents by making calls to the Portal API (PAPI)
Documents
resource, setting the
type
attribute to 'custom' and the
typeUuid
attribute to 'wiki1'.
For more information about this resource, see Portal API (PAPI).
In this article:
Add a Wiki Document
Follow these steps:
  1. Sign in to API Hub, and then click
    Wiki
    .
    If API Hub includes wiki documents, a list of them appears. Otherwise, the list is empty.
  2. The wiki documents language selector is independent of the language selector for API Hub (at the top of the page). By default, the selected language in the wiki documents language selector is the same as the selected language for API Hub. For example, if you are using API Hub with English as the selected language, and you want to add a Spanish-language wiki document, switch to Spanish using the wiki documents language selector, and then add the Spanish-language wiki document.
  3. Complete one of the following:
    • To add a top-level document, click the Add Document icon (the + icon).
    • To add a child document nested beneath a parent document, click the ellipsis icon to the right of the parent document, and then select
      Add Document
      .
  4. Add markdown content to your wiki document in the pane to the left, the edit pane.
    The edit pane is a markdown editor. The edit pane and the pane to the right, the preview pane, are a side-by-side view of the document. You can:
    • Copy and paste markdown into your document.
    • Format the content that you add using the options on the menu bar or using markdown syntax.
      For more information about markdown syntax, see the Markdown Guide.
    To preview the content that displays for consumers with read-only permissions to the document, in full-page mode, click
    Preview
    . For example, preview the content to see how the lines will break in the published document. To return the editor view, close the preview.
  5. Click
    Add Document
    .
    The Publish Document window opens.
  6. Enter the following metadata for the document, and then click
    Save
    :
    Title
    The title for the document. This is what shows on the document tree.
    Allowable characters:
    Alphanumeric characters, dashes, underscores, and spaces
    URI
    The Uniform Resource Identifier (URI) is part of the URL. It identifies this document. By default, the URI includes the encoding, that you can remove.
    Allowable characters:
    Alphanumeric characters, dashes, underscores, and spaces
    You cannot change the URI once you save this document. Spaces are replaced with underscores.
The wiki document is added to the list of documents.
You can view the URI for this newly-added document in the web browser’s address bar.
Edit a Wiki Document
Follow these steps:
  1. From the list of wiki documents, click the document that you want to edit from the list of documents to select it, and then click the Edit Mode icon (the pencil icon). Your document opens in edit mode, and options on the menu bar display.
  2. Edit the markdown content in the document or add content to the document. You can format the content using the options on the menu bar.
    A preview of your changes shows up in the pane to the right, the preview pane.
    To preview your changes in full-page mode, click
    Preview
    .
  3. Save your changes by clicking
    Publish
    .
Edit a Wiki Document's Title
Follow these steps:
  1. From the list of documents, click the ellipses icon to the right of the document that you want to edit, and then select
    Edit Metadata
    .
    The Edit Metadata window opens.
  2. Edit the title for the document, and then click
    Save
    .
The changes to the document title are saved and published.
Reorder a Wiki Document
You can reorder your wiki documents within the document tree, such as moving a document to be a child document of another document or reordering the list of wiki documents.
To reorder using the mouse,
from the list of wiki documents, click and hold the document that you want to reorder, and then drag and drop it to the new location in the tree.
To reorder using the keyboard,
from the list of wiki documents, pick up the document that you want to reorder by pressing the Spacebar key on your keyboard, navigate to the new position using the arrow keys on your keyboard, and then drop it to the new location in the tree by pressing the Spacebar key again.
Delete a Wiki Document
Deleting a parent document also deletes the child documents within the document tree (recursive delete).
Follow these steps:
  1. From the list of wiki documents, click the ellipses icon to the right of the document that you want to delete, and then select
    Delete
    .
    The Delete Document window opens.
  2. Confirm the deletion by clicking
    Yes
    .