README コンテンツ

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

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

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

  • Bitbucket に馴染みが薄い場合: [Yes, with a tutorial ] を選択して、Bitibucket での追加、編集、およびクローンについて確認することをおすすめします。
  • 十分な経験を持つユーザーの場合: [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、または .txt 拡張子で使用している場合、README にコード ハイライトを追加できます。Python Markdown でサポートされる 3 種類のハイライトについて以降に説明します。

Javascript の例
```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 の例
```java
function foo() {
int poo = 1;
	return;
}
```
Python の例
```python
friends = ['john', 'pat', 'gary', 'michael']
for i, name in enumerate(friends):
	print "iteration {iteration} is {name}".format(iteration=i, name=name)
```


スペースの活用が重要です。README は Bitbucket で次のように表示されます。

最終更新日 2018 年 8 月 21 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.