メイン コンテンツをスキップする 補完的コンテンツへスキップ

新しいページの作成

ポータルにMarkdownファイルを新しいページとして追加します。

手順

  1. API Portalリポジトリーで、contentフォルダーに移動します。
  2. 新しいMarkdownファイルを作成します。
    ファイル名はページのURLを作成するために使用されます。examples.mdという名前のファイルを作成すると、ページは<portal-url>/examplesで利用できるようになります。
  3. ページのメタデータを追加
    メタデータは---で囲まれており、ページのタイトルとヘッダー上でのその位置を定義します。ヘッダーには最低から最高までのweightのページが表示されます。weightの等しいページが複数ある場合は、アルファベット順にソートされます。デフォルトでは、"はじめに"ページのweightは10に、"APIs"ページは20に設定されています。weight: 20で"Examples"という名前の新しいページを追加すると、ヘッダー内で"APIs"の後ろに表示されます。

    ---
    title: Examples
    menu:
      main:
        weight: 20
    ---
  4. コンテンツをメタデータの下に追加します。
    Markdownへの書き込みについては、Markdown Guideをご覧ください。

    ---
    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"
      }
    ]
    ```
    情報メモヒント: コンテンツにコードサンプルを追加する場合は、```を開いた後に言語を指定して、構文の強調表示を有効にすることができます。
  5. 変更をコミットします。

タスクの結果

ポータルをデプロイすると新しいページが表示されます。この例では次のようになります。
ポータルにある新しい[例]ページのスクリーンショット。

このページは役に立ちましたか?

このページまたはコンテンツに、タイポ、ステップの省略、技術的エラーなどの問題が見つかった場合は、お知らせください。改善に役立たせていただきます。