ドキュメント

README ファイルを追加することで、Code Repositories のプロジェクトに関するドキュメントをユーザーに提供できます。Code Repositories の README ファイルは Markdown をサポートしており、柔軟で使いやすい書式設定とスタイル設定が可能です。

はじめるには、リポジトリの README.md ファイルを編集するか、追加します。このページでは、README ファイルのカスタマイズに使用できる追加機能について説明します。

README ファイルだけではドキュメントのニーズを満たせない場合は、Code Repositories を使用してカスタムドキュメントを作成し、プラットフォーム内のドキュメントとして公開できます。

機能

Code Repositories では、README 用の書式設定オプションを多数用意しています。

インライン画像プレビュー

次の構文を使用すると、リポジトリ内の画像を Markdown ファイルのテキストとともにインラインで表示できます。

![File Name](/transforms-python/path/to/my/file.jpeg)

コードリポジトリに画像をアップロードするには、リポジトリをローカルにクローンし、画像ファイルをローカルリポジトリに追加してから、変更をサーバーにプッシュする必要があります。

Foundry ユーザーをメンションする

Markdown ファイルで Foundry ユーザーをメンションするには、ユーザー名に @ 記号を接頭辞として付けて入力します。これにより、メンションしたユーザーへの参照と、そのプロフィールへの直接リンクが作成されます。

@username

Foundry リソースを参照する

リソース ID を README の Markdown ファイルに直接貼り付けることで、任意の Foundry リソースを参照できます。この方法で参照されたリソースには、自動的に名前が付けられ、プラットフォーム内の対応するリソースへのリンクが設定されます。

This repository will be deployed to ri.foundry.main.deployed-app.a00000aa-a000-000a-0000-000a0aa0a00a

リポジトリ内のファイルにリンクする

リポジトリ内のファイルへのリンクを作成するには、repo:// プロトコルの後にファイルパスを指定します。たとえば、repo://transforms-python/src/myproject/datasets/examples.py です。この方法で参照されたファイルは、クリックすると自動的に開きます。これにより、リポジトリ内のほかのファイルを簡単に参照し、移動できます。

シンタックスハイライト

README ファイルでは、コードの読みやすさを向上させるため、コードブロック内で言語のシンタックスハイライトをサポートしています。シンタックスハイライトを使用するには、次のようにコードブロックの開始区切り文字の後に言語を指定します。

Copied!
1
2
def hello_world():
    print("Hello, World!")

テーブル

標準の Markdown テーブル構文を使用して、テーブルを作成することもできます。

| Header 1 | Header 2 |
| -------- | -------- |
| Cell 1   | Cell 2   |

リンク

README 内の URL とメールアドレスは、クリック可能なリンクに自動的に変換されます。