[ターン] README.mdの構文の概要

免責事項:この記事はCC 4.0 BY-SAの著作権契約書に従って、ブロガーオリジナル記事です、複製、元のソースのリンクと、この文を添付してください。
このリンクします。https://blog.csdn.net/guodongxiaren/article/details/23690801は、
原作者のguodongxiarenに元のアドレスを保管してください再現しました:

http://blog.csdn.net/guodongxiaren/article/details/23690801

この記事では、GitHubの上のアドレスを示しています。

https://github.com/guodongxiaren/README

-------------------------------------------------- ------------------

遊びのGitHubの初め以来、それはより多くの愛を感じます。最近、そのREADME.mdファイルは非常に興味があります。私は、READMEファイルを書き込むことがより多くの学生を助けにはなりません、この記事を書きました。

READMEファイルのサフィックスMD。MDは、マークダウンが編集ブログの言語である、マークダウンの略語です。私たちは、本当に明るく、このプログラムによるブログの編集プログラム(例えばCSDNのブログ、恥ずかしいような)のブログエディタを可視化するために使用されています。しかし、GitHubには、標準のマークダウン構文の上の構文はGitHubのフレーバー記法と呼ばれる、変更されているサポート、GFMを言及しました。GFWはそれではありません。

----------------------------

README:私は具体的な効果であるコードを見て皆のために、GitHubの「README」に倉庫を建て、この記事のためにしています

継続的に更新され、この倉庫のREADMEファイルには、新しい知識は、ブログの記事に更新されないことがあります。最初は強く1は、サイトにアクセスするために360またはGitHubのSogouのブラウザを使用しないことをお勧めします、あなたがウェブサイト上のボタンをたくさん見つけるでしょう、この時点では利用できません。私たちは、GitHubのにアクセスするためのFirefoxやGoogleのブラウザの使用をお勧めします

----------------------------

README編集を開始する
あなたは既にこのファイルを持っている場合、我々は直接、オンラインREADMEファイルを編集することができますが、このファイルを持っていない場合は、ファイルディレクトリに直接それをクリックし、あなたのGitHubプロジェクトのオープン1を右プロジェクト名をクリックしてください新しいファイルを追加するためのボタン:

 

そして、あなたは編集ページを開いて、編集領域の左上隅には、ファイル名、サフィックスの注目を記入する領域があるた.md

 

あなたが再編集し、それには、このファイルを持っている場合は、ファイルディレクトリ内のファイルをクリックし、上部のツールバーがあり、[編集]を選択します

 

何のコンテンツがクリックされていないされていない場合、新しいファイルは、新しいファイルボタンをコミットがある場合そして、次にスクロールします。古いファイルが編集に再構築されている場合、このボタンは表示された変更をコミット

 

これは360またはSogouのブラウザTucaoの方法である場合は、//、このボタンは常に恥ずかしい、クリックされていません。

まず、ちょうどこの新しいファイルを提出する何かを書き、それを再度開くには、[編集]をクリックします。あなたは、左上隅には、編集エリアを変更されているでしょう。

 

我々の編集モードデフォルトコード、で選択されています。あなたはプレビュー(プレビュー)をクリックすると、リアルタイムで現在の表示の効果を表示することができます。

さて、ここで私たちは、このファイルを編集し始めました

 

タイトルに関する
規範のREADMEファイルの先頭に見出しと呼ばれているタイトル、上で書かれています。

見出しは
====
プラス等号以下のテキストでは=、その上のテキストは、見出しとなります。無制限の数は、ああ、数に等しいが、0より大きくなければなりません。
見出しは見出しドットよりも表示されているタイトル、であるよりも低いレベル。

題し
-------
以下のテキストに下線で- 、そしてテキストの上部がタイトルになり、同じ数に制限はありません強調しました。

ショー結果 - また、あなたが大規模でしょう、タイトルの下に横線がある、はい、これは=とあります。

あなたが唯一の等号=が、それ以上の無いテキストを入力した場合、それは直線のみが表示されます。あなたは上記のテキストを持っていますが、あなただけの水平線を表示したい場合は、かなり上部に大型タイトルのテキストに脱出しようとするよりも、あなたが同数とテキストになります=直接空白行を埋めます。

空行を入力します。それは非常に一般的に使用され、上下に2つの異なるレイアウトをしたくないときに、空行を埋める際に必要な2つのレイアウトの間で一緒に千鳥。

あなただけのダッシュ(マイナス)を入力した場合 - 、それ以上何もテキストが、あなたはマイナス記号が3以上記述する必要があり、直線を表示したいん。しかし、破線の代わりに実線表示される異なる表示の等しい数を有します。マイナス符号と同じ役割をし、アスタリスク*アンダースコア_ 3を書くこと以上の仮想水平線を表示する必要があり、どちらも同じ記号があります。

また、タイトルに表現のレベルも、6つのレベルに分割され、順番に表示されるテキストのサイズを縮小します。異なるレベルを識別するための番号#(シャープ)です。タイトルは#小見出しは2を持っている、というように、#を持っています。

タイトル#
##小見出し
###タイトル3
####タイトル4
#####タイトル5
###### 6タイトル
サイド書き込みにより、ライン側にノート#(シャープ)のタイトルと名前、ディスプレイに示されるように:


実際、以前はそれぞれ、タイトルとタイトルを記載し、そして対応する見出しと小見出し。すなわち、タイトルとサイズ同じタイトル、同じタイトルや小見出しサイズ。

表示テキスト


通常のテキスト
、テキストの直接入力は通常のテキストです。搬送ラインフィードに直接行を変更したくない場合は、(または)<BR>使用することに注意してください。これは、htmlタグの内側に、です。実際には、いくつかのHTMLタグをサポートして値下げ、あなたが試すことができます。あなたは完全に言葉を書くためにHTMLを使用する場合はもちろん、意味がすべての値下げは、フロントを行うように設計されていませんした後、失われたが、一般的にのみ効果を達成され、HTMLよりも多くの友人を書くために単純すぎるだろう。

これはプレーンテキストである
、<BR>直接ラップしないでを入力してください
\ <BR>使用する
前にバックスラッシュを付け三行目\に<BR>注意を。目的は脱出を達成することであるように、他の言語と同様に、<脱出。
効果はのようになります。

 

また、ハイパーリンクを表示するには、その後、直接、うまくリンクのURLを入力してください。これは、自動的にフォームのリンクになり表示しました。

小さなヒントのスペースを表示する
ラインスペースのデフォルトのテキストは無視されていますが、バージョンに関する行にスペースが必要な場合は、それを行う方法、OKフルオンに半値幅によってあなたの入力方法にある少しスキルがあり、友人。
テキストの一行
二行のテキストタブオペレータの実装を使用しました。

こんにちは、みなさん、こんにちは、私はフルーツドンXiarenています。
2つのフロントタブがあることに注意してください。示すように、ディスプレイ上のテキストのGitHubの一行:


複数行テキストの
複数行のテキストと各ラインと2つのタブの開始限り、に似て単一行のテキスト

訪問する歓迎
お会いできて嬉しい
私はあなたを願って、良い朝、良い午後、良い午後、良い夜

 

パートは、テキストをハイライト表示され
、あなたが果たした役割を強調するために、ディスプレイの通路を強調したテキストの一部を作りたい場合は、あなたが``とそれを囲むことができます。これは、上記の左ボタン番号1(ノート英語の入力方法)単一引用符ではなく、タブのことに注意してください。

`You`ありがとうございます。`Call`ミー` Coder`してください

 

テキスト、ハイパーリンク
テキストのハイパーリンク形式には、[表示するテキスト]この(リンクアドレス)です。例えば:

[マイブログ](http://blog.csdn.net/guodongxiaren)
ディスプレイ:

あなたはまた、彼にプラスホバーテキスト表示を与えることができます。

[マイブログ](http://blog.csdn.net/guodongxiaren「ホバー表示」)
URLの後の文字列に二重引用符で囲まれています。また、ここで注意二重引用符です。


キャレット
ドット文字
、ドット文字である
ことは、シンボルドットもある
段落の上のドットは、CSDNは、エディタ内のブログ箇条書きです。記載されている記事エントリを書き込む際に頻繁に使用されます。また、値下げのGitHubの中にドット演算子の構文の使用をサポートしています。アスタリスクを編集するときに使用します*

*ニックネーム:フルーツドンXiaren
*別名:隣のファラオ
*英語名:ゼリーは
アスタリスク*の後ろにスペースがあることに留意すべきです。それ以外の場合は、通常のアスタリスクとして表示されます。上記のように表示します:


また、2つのドットと3つのドットがあります。1より多くのタブがあります。

*プログラミング言語
*スクリプト言語
* Pythonは
第2のタブ、第2行目のタブ行。これは、効果を確認するために、それを表現するために使用しても、より明確な階層です。


あなたは3の構造を明確に表現するだけでは十分ではないと思われる場合、我々はフォームを変更しようとすることができ、囲まれた文字を参照してください。

 

インデント
インデントの意味は理解しやすいです。

>データ構造
>>ツリー
>>>バイナリ
>>>>バランスバイナリツリー
>>>>>完全なバイナリ
表示:

もちろん、これよりも一般的な使用法はケースです。効果は、多くの場合、他の人のような記事で引用され、書籍に見ることができます。結果を確認するために指示します。

 

 

この特定の「インデント」の使用。彼らはすべてのそれを探ります。

画像を挿入


ネットワークからの写真


多くのオンラインチュートリアルを何回も絵挿入しREADME、と自分でそれをテストがあり、あなたが使用する最も簡単な見つけることができる、最も基本的な構文は次のとおりです。

![](http://www.baidu.com/img/bdlogo.gif)
画像URLで感嘆符で感嘆符!+大括弧[] +括弧()です。

あなたは感嘆符を追加しない場合!、それは、プレーンテキストのBaiduとなります。

角括弧でそのように、識別情報の一部を追加することができ

![百度](http://www.baidu.com/img/bdlogo.gif)
あなたはホバーメッセージを表示到達したい場合は、角括弧のBaiduはあなたができる、画像表示への変更が発生することはありません以前のテキストで説明した方法をモデルに、それはこれです:

![百度](http://www.baidu.com/img/bdlogo.gif「Baiduのロゴ」)
URL、プラスディスプレイに示すように、二重引用符で囲まれた文字列の後ろに:

 


GitHubの倉庫の写真は、
URLが失敗する可能性があるので、時々 、GitHubのリポジトリ(またはプロジェクト)絵ではなく、絵のネットワークの他のソース、他のソースを表示したいです。それでは、どの写真でGitHubのプロジェクトを表示するには?

実際には、上記のフォーマットと一致し、その差は書き方を括弧のURLです。

    絵の下https://github.com/は、プロジェクトのユーザー名/名前/生/支店名/画像格納フォルダ/フォルダ

だから、それをクリアします。例えば:

![](https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif)
GitHubの上で自分のユーザー名のguodongxiaren;プロジェクトのImageCacheがあり、生のデータは、それの本来の意味を表し、気にしないでくださいそれ;メインブランチマスター、プロジェクトフォルダのロゴがあり、ロゴの下のフォルダforyou.gif絵があります


プラス画像へのハイパーリンクは、
指定したWebページに画像をクリックすることで、ハイパーリンク機能、一緒に写真を作りたい場合。あなたは書くことができます。

[![百度]](http://baidu.com)
[百度]:HTTP: "Baiduのロゴ" //www.baidu.com/img/bdlogo.gif
全く異なるこれら二つ前の文言が、また、簡単に模倣書き込みに、それはあまりにも多くを導入していません。百度のコンテキストにだけ注意を払うには、識別し、あなた自身のプレーは、自由であるという名前ですが、同じの識別上下二列ことを確認する必要があります。
私たちは、サイトの機能を実現することができるように絵をクリックします。


コードの断片を挿入
我々は行の数字`とコードの次の行を必要としています。3より`単一引用符が、左側の番号1、タブキートップキー。限り、あなたは`` `(ケース無視)した後、あなたのプログラミング言語を追加することができますようシンタックスハイライトを達成するために。C ++言語は、C ++のcppに書き込むことができます。コードを見てください:

 

実際の表示

 

[余談]それはとGitHubの要旨日記に
非常に多くのマークダウン構文を読んで、あなたは、単にREADMEファイルを書き込み、書き込み記事への実際の使用のマークダウン構文を開始するか、それをブログに試してみたいと満たさなければなりません。確かに、インターネットは、支持値下げ構文やブログに頼っています。しかし、その後、それはあなたが--GistのGitHub自体の機能を利用することができ、より便利です。

要旨はないユニットとしてプロジェクトに、単位としてファイルです。そして、ビルド倉庫に通常のGitHubのとは違って、要旨はああ、プライベートです。一般的なプロジェクトも一見負った民間の道を支払うために、デフォルトで公開されています。書き込み日記に使用して、それはプライベートなので、それは素晴らしいです。

ページのGitHubのトップは、次のとおりです。

 

ポイントへ:

 

それはあなたがテキストテキストをサポートしていますが、あまりにもプログラミング言語の多様性をサポートするだけでなく、民間の文書を、編集できるものです!もちろん、値下げを含みます。ファイル名を入力します。

 

最後には、保存された秘密の要旨は自分のプライベートで作成]を選択します。


----------------
免責事項:この記事は元の記事にCSDNブロガー「ドンXiarenの果実」で、CC 4.0 BY-SAの著作権契約書に従って、再現し、元のソースと、このリンクを添付してください声明。
オリジナルリンクします。https://blog.csdn.net/guodongxiaren/article/details/23690801

おすすめ

転載: www.cnblogs.com/Sherlock09/p/11910222.html