README コンテンツ

README は、リポジトリを訪問した他のユーザーが参照するための資料であり、リポジトリにあるアプリケーションを起動して実行するための手順が記載されています。README ファイルは、ローカルまたは Bitbucket Cloud 上で直接追加および編集できます。

Bitbucket で README を追加および編集する

リポジトリを作成するときに、[Include a README?] フィールドが表示されます。

  • Bitbucket を初めて使用する場合: [Yes, with a tutorial (はい、チュートリアルあり)] を選択すると、Bitbucket での追加、編集、クローン作成方法を簡単に学べます。

  • 十分な経験を持つユーザーの場合: [Yes, with a template (はい、テンプレートあり)] を選択して、情報の種類に関する提案やガイドラインを盛り込んだコンテンツを README に追加します。

[No] を選択した場合も、リポジトリの [ソース] ページで引き続き [Create a README] を選択できます。README を用意したら、[Edit README] をクリックして、Bitbucket 内で README を更新できます。

README をマークアップで整形する

Bitbucket の README ファイルでは、MarkdownreStructuredTextTextile、プレーン テキストをパースおよび表示できます。Markdown などのシンタックスを使用することで、テキストを強調したり、画面キャプチャを含めたりすることができます。

Bitbucket の Markdown のサポートやシンタックス例のチュートリアルについては、Markdown デモのリポジトリをご参照ください。

拡張子と言語について

Bitbucket がファイル内のマークアップをパースする方法は、README で使用するファイル拡張子に応じて異なります。たとえば、Bitbucket は README.md を Markdown 言語を使うファイルとして扱います。既知のファイル拡張子の README ファイルが優先的に扱われます。複数の拡張子を持つ複数の README ファイルがある場合、Bitbucket は既知の形式に一致する最初のファイルを参照します。

Bitbucket の README ファイルでは、Creole マークアップを除き、wiki ファイルと同じマークアップがサポートされます。この表では、サポートされるファイル拡張子と、それぞれに対応するマークアップ言語について説明します。

拡張子

言語

.md
.mkd
.mkdn
.mdown
.markdown 
.text 

マークダウン

Python-Markdown でサポートされる拡張子codehilitetablesdef_listdelfootnotesheaderidsane_listsabbrfenced_codetocwikilinks

Markdown では <table> タグなどの任意 html はサポートされません。

.rst

reStructuredText (reST)

.textile

Textile

.wiki

Creole

Bitbucket wiki のみ。README ファイルではサポートされません。

 

コードのハイライト

Python Markdown (拡張子が .md、.mkdn、.markdown、または .text ) を使用している場合、コード ハイライトを README に追加できます。以下では、Python Markdown でサポートされる 3 種類のハイライトを例示しています。スペースは正確に挿入してください。

Javascript の例
1 2 3 4 5 ```javascript if (window.name=='' || (window.name.indexOf('wicket') > -1 && window.name!='wicket-wicket:default')) { window.location="register/wicket:pageMapName/wicket-0" + (window.location.hash != null ? window.location.hash : ""); } ```
Java の例
1 2 3 4 5 6 ```java function foo() { int poo = 1; return; } ```
Python の例
1 2 3 4 5 ```python friends = ['john', 'pat', 'gary', 'michael'] for i, name in enumerate(friends): print "iteration {iteration} is {name}".format(iteration=i, name=name) ```

 

最終更新日 2020 年 8 月 24 日
次でキャッシュ 1:39 AM on Oct 16, 2021 |

その他のヘルプ