フォルダのお知らせ (README)

フォルダにREADME.mdファイルを作成すると、フォルダを開くたびにファイル一覧の下に内容が自動で表示されます。チームメンバーにフォルダの利用ルールやプロジェクトの案内を伝えるのに活用できます。フォルダごとに案内文を付けておくと、社内Wikiを別途用意しなくても、各フォルダがそれぞれの案内ページの役割を果たします。

始める前に

• 管理者設定：サービス構成 > ファイルエリアでREADME.md を即時表示をオンにすると、フォルダを開いたときにREADMEが自動で表示されます。

README.mdファイルのアップロード

フォルダの中にREADME.mdファイルを作成するか、アップロードします。 ファイル名のルール、フォルダの案内、プロジェクトの進行状況などをMarkdown形式で記述します。

フォルダ構造から下書きを作成する

最初から書くのが手間な場合は、フォルダ構造とファイル一覧を自動で出力して下書きを作成できます。

フォルダ上部のフォルダ整理ボタンを押し、README作成タブでファイルを作成ボタンを押します。

現在のフォルダのフォルダとファイルの一覧を記載したREADME.mdファイルがフォルダに作成されます。このファイルを書き直してREADMEの下書きとして使えます。README.mdがすでにある場合は、名前を付けて保存と上書きのいずれかを選択します。

内容の表示

フォルダを開くと、ファイル一覧の下にREADME.mdの内容が自動で表示されます。

注意事項

• フォルダごとに1つのREADMEのみ認識されます
• ファイル名は大文字・小文字のどちらでも認識されます。

関連ドキュメント

• ファイル/フォルダコメント
• マークダウン、テキストファイルの表示と編集