プロジェクト

全般

プロフィール

Mastering-markdown-jp » 履歴 » バージョン 4

健二 酒井, 2019/04/23 23:23

1 1 健二 酒井
# Mastering-markdown-jp
2 1 健二 酒井
3 1 健二 酒井
## 訳にあたって
4 1 健二 酒井
5 1 健二 酒井
翻訳元:https://guides.github.com/features/mastering-markdown/
6 1 健二 酒井
結構端折ってます。
7 1 健二 酒井
8 1 健二 酒井
Markdown は軽くて簡単に使える言語です。GitHubプラットフォームで文章を記述するために使用できます。
9 1 健二 酒井
10 1 健二 酒井
**何が身につくか**
11 1 健二 酒井
12 1 健二 酒井
- どのようにMarkdownを利用するか
13 1 健二 酒井
- Markdownはこれまでのものとどう違うか。
14 1 健二 酒井
- GitHubのMarkdown自動レンダリングの活用
15 1 健二 酒井
- GitHubの独自拡張をどう利用するか 
16 1 健二 酒井
17 1 健二 酒井
## Markdownってなに?
18 1 健二 酒井
19 1 健二 酒井
MarkdownはWebで文章を書くための方法です。ドキュメントの表示を取り扱います。
20 1 健二 酒井
つまり、太字や斜体、画像の追加、リストの作成を簡単に行えます。
21 1 健二 酒井
\#や\*を除き、Markdownはほとんど文章そのままです。
22 1 健二 酒井
23 1 健二 酒井
GitHubの多くの場所でMarkdownを使うことができます。
24 1 健二 酒井
25 1 健二 酒井
* Gists
26 1 健二 酒井
* イシュー、プルリクエストのコメント
27 1 健二 酒井
* .md、.markdown形式のファイル
28 1 健二 酒井
29 1 健二 酒井
もっと知りたい場合は、GitHubヘルプ内の「GitHubで書く」をご覧ください。
30 1 健二 酒井
31 1 健二 酒井
## 例
32 1 健二 酒井
33 1 健二 酒井
### テキスト
34 1 健二 酒井
35 1 健二 酒井
> ```
36 1 健二 酒井
> It's very easy to make some words **bold** and other words *italic* with Markdown. You can even [link to Google!](http://google.com)
37 1 健二 酒井
> ```
38 1 健二 酒井
> 
39 1 健二 酒井
> It's very easy to make some words **bold** and other words *italic* with Markdown. You can even [link to Google!](http://google.com)
40 1 健二 酒井
> 
41 1 健二 酒井
> ### リスト
42 1 健二 酒井
> 
43 1 健二 酒井
> ```
44 1 健二 酒井
> Sometimes you want numbered lists:
45 1 健二 酒井
> 
46 1 健二 酒井
> 1. One
47 1 健二 酒井
> 2. Two
48 1 健二 酒井
> 3. Three
49 1 健二 酒井
> 
50 1 健二 酒井
> Sometimes you want bullet points:
51 1 健二 酒井
> 
52 1 健二 酒井
> * Start a line with a star
53 1 健二 酒井
> * Profit!
54 1 健二 酒井
> 
55 1 健二 酒井
> Alternatively,
56 1 健二 酒井
> 
57 1 健二 酒井
> - Dashes work just as well
58 1 健二 酒井
> - And if you have sub points, put two spaces before the dash or star:
59 1 健二 酒井
> - Like this
60 1 健二 酒井
> - And this
61 1 健二 酒井
> ```
62 1 健二 酒井
> 
63 1 健二 酒井
> Sometimes you want numbered lists:
64 1 健二 酒井
> 
65 1 健二 酒井
> 1. One
66 1 健二 酒井
> 2. Two
67 1 健二 酒井
> 3. Three
68 1 健二 酒井
> 
69 1 健二 酒井
> Sometimes you want bullet points:
70 1 健二 酒井
> 
71 1 健二 酒井
> * Start a line with a star
72 1 健二 酒井
> * Profit!
73 1 健二 酒井
> 
74 1 健二 酒井
> Alternatively,
75 1 健二 酒井
> 
76 1 健二 酒井
> - Dashes work just as well
77 1 健二 酒井
> - And if you have sub points, put two spaces before the dash or star:
78 1 健二 酒井
> - Like this
79 1 健二 酒井
> - And this
80 1 健二 酒井
81 1 健二 酒井
### 画像
82 1 健二 酒井
83 1 健二 酒井
> ```
84 1 健二 酒井
> If you want to embed images, this is how you do it:
85 1 健二 酒井
> 
86 1 健二 酒井
> ![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)
87 1 健二 酒井
> ```
88 1 健二 酒井
> 
89 1 健二 酒井
> If you want to embed images, this is how you do it:
90 1 健二 酒井
> 
91 1 健二 酒井
> ![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)
92 1 健二 酒井
> 
93 1 健二 酒井
### 見出しと引用
94 1 健二 酒井
95 1 健二 酒井
> ```
96 1 健二 酒井
> # Structured documents
97 1 健二 酒井
> 
98 1 健二 酒井
> Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.
99 1 健二 酒井
> 
100 1 健二 酒井
> ### This is a third-tier heading
101 1 健二 酒井
> 
102 1 健二 酒井
> You can use one `#` all the way up to `######` six for different heading sizes.
103 1 健二 酒井
> 
104 1 健二 酒井
> If you'd like to quote someone, use the > character before the line:
105 1 健二 酒井
> 
106 1 健二 酒井
> > Coffee. The finest organic suspension ever devised... I beat the Borg with it.
107 1 健二 酒井
> > - Captain Janeway
108 1 健二 酒井
> ```
109 1 健二 酒井
> 
110 1 健二 酒井
> # Structured documents
111 1 健二 酒井
> 
112 1 健二 酒井
> Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.
113 1 健二 酒井
> 
114 1 健二 酒井
> ### This is a third-tier heading
115 1 健二 酒井
> 
116 1 健二 酒井
> You can use one `#` all the way up to `######` six for different heading sizes.
117 1 健二 酒井
> 
118 1 健二 酒井
> If you'd like to quote someone, use the > character before the line:
119 1 健二 酒井
> 
120 1 健二 酒井
> > Coffee. The finest organic suspension ever devised... I beat the Borg with it.
121 1 健二 酒井
> > - Captain Janeway
122 1 健二 酒井
123 1 健二 酒井
124 1 健二 酒井
### コード
125 1 健二 酒井
126 1 健二 酒井
preタグが邪魔なのでうまく書けぬ…
127 1 健二 酒井
128 1 健二 酒井
### 追加機能
129 1 健二 酒井
130 1 健二 酒井
> ```
131 1 健二 酒井
> GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater!
132 1 健二 酒井
> 
133 1 健二 酒井
> But I have to admit, tasks lists are my favorite:
134 1 健二 酒井
> 
135 1 健二 酒井
> - [x] This is a complete item
136 1 健二 酒井
> - [ ] This is an incomplete item
137 1 健二 酒井
> 
138 1 健二 酒井
> When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!
139 1 健二 酒井
> 
140 1 健二 酒井
> And, of course emoji!
141 1 健二 酒井
> ```
142 1 健二 酒井
> 
143 1 健二 酒井
> > GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater!
144 1 健二 酒井
> 
145 1 健二 酒井
> But I have to admit, tasks lists are my favorite:
146 1 健二 酒井
> 
147 1 健二 酒井
> - [x] This is a complete item
148 1 健二 酒井
> - [ ] This is an incomplete item
149 1 健二 酒井
> 
150 1 健二 酒井
> When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!
151 1 健二 酒井
> 
152 1 健二 酒井
> And, of course emoji!
153 1 健二 酒井
154 1 健二 酒井
## 文法ガイド
155 1 健二 酒井
156 1 健二 酒井
この章では、Markdown文法についての概要です。これらはGitHub.comやテキストファイルで使用できます。
157 1 健二 酒井
158 1 健二 酒井
### 見出し(Headers)
159 1 健二 酒井
160 1 健二 酒井
```
161 1 健二 酒井
# これは<h1>タグになります
162 1 健二 酒井
## これは<h2>タグになります
163 1 健二 酒井
####### これは<h6>タグです
164 1 健二 酒井
```
165 1 健二 酒井
166 1 健二 酒井
### 強調(Emphasis)
167 1 健二 酒井
168 1 健二 酒井
```
169 1 健二 酒井
*このテキストは斜体になります*
170 1 健二 酒井
_このテキストも斜体になります_
171 1 健二 酒井
172 1 健二 酒井
**これは太字になります**
173 1 健二 酒井
__これも太字になります__
174 1 健二 酒井
175 1 健二 酒井
176 1 健二 酒井
_これらを **あわせて** 使うこともできます_
177 1 健二 酒井
```
178 1 健二 酒井
179 1 健二 酒井
180 1 健二 酒井
### リスト(Lists)
181 1 健二 酒井
182 1 健二 酒井
#### 順序なし
183 1 健二 酒井
184 1 健二 酒井
```
185 1 健二 酒井
* 項目 1
186 1 健二 酒井
* 項目 2
187 1 健二 酒井
    * 項目 2a
188 1 健二 酒井
    * 項目 2b
189 1 健二 酒井
```
190 1 健二 酒井
191 1 健二 酒井
### 順序あり
192 1 健二 酒井
193 1 健二 酒井
```
194 1 健二 酒井
1. 項目 1
195 1 健二 酒井
1. 項目2
196 1 健二 酒井
1. 項目 3
197 1 健二 酒井
    1. 項目 3a
198 1 健二 酒井
    1. 項目 3b
199 1 健二 酒井
```
200 1 健二 酒井
201 1 健二 酒井
### 画像(Images)
202 1 健二 酒井
203 1 健二 酒井
```
204 1 健二 酒井
![GitHubロゴ](/images/logo.png)
205 1 健二 酒井
形式: ![Alt Text](url
206 1 健二 酒井
```
207 1 健二 酒井
208 1 健二 酒井
### リンク(Links)
209 1 健二 酒井
210 1 健二 酒井
```
211 1 健二 酒井
http://github.com - 自動でリンクされます!
212 1 健二 酒井
[GitHub](http://github.com)
213 1 健二 酒井
```
214 1 健二 酒井
215 1 健二 酒井
### 引用(Blockquotes)
216 1 健二 酒井
217 1 健二 酒井
``` 
218 1 健二 酒井
カニエ・ウェストは言った:
219 1 健二 酒井
220 1 健二 酒井
> 我々は未来を生きている。
221 1 健二 酒井
> 今とは過去なのだ。
222 1 健二 酒井
```
223 2 健二 酒井
224 2 健二 酒井
### インラインコード(Inline code)
225 2 健二 酒井
226 2 健二 酒井
```
227 2 健二 酒井
代わりにここは
228 2 健二 酒井
`<addr>`要素を使うべきだと考えている
229 2 健二 酒井
```
230 2 健二 酒井
231 2 健二 酒井
## GitHub式Markdown(GitHub Flavored Markdown)
232 2 健二 酒井
233 2 健二 酒井
GitHub.comはいくつか便利な機能を追加したバージョンのMwarkdownを使用しています。
234 2 健二 酒井
これらはGitHubでの活動をより簡単にします。
235 2 健二 酒井
236 2 健二 酒井
GitHub式Markdownの機能のいくつかは概要(descriptions)とイシューやプルリクエストでのコメント(comments of Issues and Pull Requests)だけで使うことができます。これらは
237 2 健二 酒井
これらはSHA1ハッシュ、イシュー、プルリクエストへの参照、@mentionsを含みます。
238 2 健二 酒井
タスクリストはGistコメント、Gist Markdownファイルでも使用可能です。
239 2 健二 酒井
TODO なんかここ訳がイマイチ
240 2 健二 酒井
241 2 健二 酒井
### シンタックスハイライト
242 2 健二 酒井
243 2 健二 酒井
### タスクリスト
244 2 健二 酒井
245 2 健二 酒井
### 表
246 2 健二 酒井
247 2 健二 酒井
最初の行とそれ以外の行を-(ハイフン)で区切ります。これは最初の行のためにです。
248 2 健二 酒井
各列は|(パイプ)で区切ります
249 2 健二 酒井
250 2 健二 酒井
```
251 2 健二 酒井
First Header | Second Header
252 2 健二 酒井
------------ | -------------
253 2 健二 酒井
Content from cell 1 | Content from cell 2
254 2 健二 酒井
Content in the first column | Content in the second column
255 2 健二 酒井
```
256 2 健二 酒井
257 2 健二 酒井
これは以下のようになります。
258 2 健二 酒井
259 2 健二 酒井
First Header | Second Header
260 2 健二 酒井
------------ | -------------
261 2 健二 酒井
Content from cell 1 | Content from cell 2
262 2 健二 酒井
Content in the first column | Content in the second column
263 2 健二 酒井
264 2 健二 酒井
### SHA参照
265 2 健二 酒井
266 2 健二 酒井
コミットハッシュへの参照は自動的にGitHub上のコミットへのリンクとなります。
267 2 健二 酒井
268 2 健二 酒井
```
269 2 健二 酒井
16c999e8c71134401a78d4d46435517b2271d6ac
270 2 健二 酒井
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
271 2 健二 酒井
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
272 2 健二 酒井
```
273 2 健二 酒井
274 2 健二 酒井
### リポジトリのイシュー参照
275 2 健二 酒井
276 2 健二 酒井
イシューやプルリクエストを参照する数字は自動でリンクになります
277 2 健二 酒井
278 2 健二 酒井
```
279 2 健二 酒井
#1
280 2 健二 酒井
mojombo#1
281 2 健二 酒井
mojombo/github-flavored-markdown#1
282 2 健二 酒井
```
283 2 健二 酒井
284 2 健二 酒井
### ユーザー名の@メンション
285 2 健二 酒井
286 2 健二 酒井
@に続けてユーザー名を入力すること、その人へコミットを見るように通知を送れます。これを"@メンション"と呼ばれます。
287 2 健二 酒井
何故ならこれは個別に述べる(mentioning)ことだからです。@メンションは組織のチームにも行えます。
288 2 健二 酒井
289 2 健二 酒井
### URLの自動リンク
290 2 健二 酒井
291 2 健二 酒井
URL(http://www.github.com/のような)は自動でリンクになります。
292 2 健二 酒井
293 2 健二 酒井
### 取り消し線
294 2 健二 酒井
295 3 健二 酒井
二つのチルダで囲む(`~~このように~~`)ことで取り消し線になります。
296 2 健二 酒井
297 2 健二 酒井
### 絵文字
298 2 健二 酒井
299 2 健二 酒井
GitHubは絵文字をサポートします。
300 2 健二 酒井
301 2 健二 酒井
サポートしてる絵文字の画像はEmoji Cheat Sheetを見てください。