たいのですが試私のreadme.mdファイルのように見え始する前にgithub?[定休日]

StackOverflow https://stackoverflow.com/questions/9331281

質問

皆様にお伝えしたくて書き込み、readme私のgithubのプロジェクト。md形式です。があるので、いい試私のreadme.mdファイルのように見え始する前にgithub?

役に立ちましたか？

解決

多くの方法：あなたがMac上であれば、使用覚書の

ブラウザでテストしたい場合は、

は、あなたが@Aaronまたは StackEdit を試みることができます Notepag にはには思わ以来のhref = "http://dillinger.io/" のrel = "noreferrer">デリンジャーを今ダウンしています。それだけで動作し、私のブラウザのローカルデータベースにすべての私の文書が保存されますので、個人的に私はデリンジャーを使用します。

他のヒント

原子 作品のカットなどの値下げのファイルとヒット Ctrl+Shift+M 切り替え、値下げのプレビューパネルがあります。取り扱いはHTMLや画像もございます

Atom screenshot

この1はかなりの時間のために信頼性が証明されています： http://tmpvar.com/markdown.html

このかわいらしい古い問題として見ながらネットで検索しも私の答えで有用である。さん非常に有CLIを起動ツールのレンダリングGitHub風味のmarkdown: グリップ.このGitHubのAPIでは、このようにするのではないでしょうか。

正直に言うと、開発者の グリップ, は、詳しい答えにこれらも同様の質問:

私は通常は直接GitHubのウェブサイト上で編集し、それを、ちょうど編集ウィンドウ上の「プレビュー」をクリックします。

おそらく、それはこのポストが行われた以降に追加されます新機能です。

の Visual Studioのコードはの編集、プレビューMDファイル変更するオプションがあります。 VSコードは、プラットフォーム独立しているため、これは、Windows、Mac、Linuxのために働くだろう。

ビュー、エディタで記者の Ctrlキー+ Shiftキー+ V を切り替えるために

。あなたは、プレビューを表示することができますサイド・バイ・サイドの（Ctrlキー+ K V）のファイルを編集しているとあなたの編集などをリアルタイムに反映された変更を参照してください。

また...

Q：？んVSコードのサポートGitHubのフレーバー値下げ

A：いいえ、VSのコードは、マークダウン、それライブラリを使用してCommonMark値下げ仕様をターゲットにしています。 GitHubのはCommonMark仕様に向かって移動している。

詳細ここを

ウェブでは、使用デリンジャーに。それは素晴らしいです。

あなたはこの1つを見てみたいことがあります：

https://github.com/kristjanjansen/md2htmlする

を使用してい地域主催のHTMLファイルをプレビュー GitHub readmes.

また複数の既存のオプションが決定したロールを自分なりに次の要件を満たす必要が

  • シングルファイル
  • 地元主催のイントラネットURL
  • ないブラウザ拡張に必要な
  • 無地が主催すサーバー側の処理（例えば、サポートに対するコミットメント
  • 軽量（例えば、jQuery)
  • 高忠実度:利用GitHubを描画するために値下げ、同CSS

また地元のコピーのGitHubリポジトリの兄弟ディレクトリの下に"github"をクリックします。

各レポ-レートディレクトリに含まれるREADME.mdファイル:

.../github/
           repo-a/
                  README.md
           repo-b/
                  README.md
           etc.

のgithubのディレクトリの"プレビューが"HTMLファイル:

.../github/
           readme.html

プレビュー、readme、閲覧github/readme.htmlを指定して、レポ-レートにクエリ文字列:

http://localhost/github/readme.html?repo-a

また、お客様のコピーできるのreadme.html 同じディレクトリとしてREADME.md、記のクエリー文字列:

http://localhost/github/repo-a/readme.html

の場合readme.html は同一ディレクトリとしてREADME.mdについてreadme.html 以上HTTP:できるだけ開から直接ファイルシステム。

HTMLファイルを使用し GitHub API 描画のための値下げにREADME.mdファイルです。あ 率の制限:時には、 60請求時.

作品がほとんど無かった現在の生産バージョンのChrome、IE、Firefox Windows7です。

源

ここではHTMLファイルreadme.html):

<!DOCTYPE html>
<!--
     Preview a GitHub README.md.

     Either:

     -  Copy this file to a directory that contains repo directories,
        and then specify a repo name in the query string.

        For example:

          http://localhost/github/readme.html?myrepo

     or

     -  Copy this file to the directory that contains a README.md,
        and then browse to this file without specifying a query string.

        For example:

          http://localhost/github/myrepo/readme.html

        (or just open this file in your browser directly from
        your file system, without HTTP)
-->
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
<meta name="author" content="Graham Hannington"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GitHub readme preview</title>
<link rel="stylesheet" type="text/css" href="http://primercss.io/docs.css"/>
<script type="text/javascript">
//<![CDATA[
var HTTP_STATUS_OK = 200;
var URL_API_GITHUB_RENDER_MARKDOWN = "https://api.github.com/markdown/raw";
var README_FILE_NAME = "README.md";

var readmeURL;

var queryString = location.search.substring(1);

if (queryString.length > 0) {
  readmeURL = queryString + "/" + README_FILE_NAME;
} else {
  readmeURL = README_FILE_NAME;
}

// Get Markdown, then render it as HTML
function getThenRenderMarkdown(markdownURL) {
  var xhr = new XMLHttpRequest();
  xhr.open("GET", markdownURL, true);
  xhr.responseType = "text";
  xhr.onload = function(e) {
    if (this.status == HTTP_STATUS_OK) {
     // Response text contains Markdown
      renderMarkdown(this.responseText);
    }
  }
  xhr.send();
}

// Use the GitHub API to render Markdown as HTML
function renderMarkdown(markdown) {
  var xhr = new XMLHttpRequest();
  xhr.open("POST", URL_API_GITHUB_RENDER_MARKDOWN, true);
  xhr.responseType = "html";
  xhr.onload = function(e) {
    if (this.status == HTTP_STATUS_OK) {
      document.getElementById("readme").innerHTML = this.response;
    }
  }
  xhr.send(markdown);
}

window.onload = function() {
  getThenRenderMarkdown(readmeURL);
}
//]]>
</script>
</head>
<body>
<header class="masthead">
<div class="container">
<span class="masthead-logo"><span class="mega-octicon
octicon-mark-github"></span>GitHub readme preview</span>
</div>
</header>
<div class="container">
<div id="readme" class="markdown-body">
<p>Rendering markdown, please wait...</p>
</div>
<footer class="footer">Rendering by
<a href="https://developer.github.com/v3/markdown/">GitHub</a>,
styling by <a href="http://primercss.io/">Primer</a>.</footer>
</div>
</body>
</html>

発注

  • 通常のメリットは私のコードがIIFEが、この場合、こちらでお分かりになったので、思い思いので簡潔に
  • しんの悩支援backlevel IE
  • のための簡潔性、省エラーコードの取り扱いないはずだと思い込んでいるところか!)
  • い歓迎のJavaScriptプログラミングのヒント

アイデア

  • 私の考えをGitHubリポジトリのためこのHTMLファイルを入れることが、ファイルのgh-ページに支店、GitHubいていることで"通常の"ウェブページです。いのitunesファイルの受け入れ、完全なURLのREADMEファイル(またはその他のMarkdownファイル）を-としてのクエリ文字列です。私は見ているかどうか主催のGitHubが訪れているのGitHubのAPI要求の制限やかに抵触のクロスドメインの課題（利用のAjax要求の値下げからとは別のドメインのドメインのHTMLページ上）。

オリジナル版(推奨されていません)

って保存する記録のオリジナル版のための好奇心値です。このバージョンが以下の問題を解決し、現在のバージョン:

  • すものであることを踏まえればいくつかのファイルのダウンロード
  • な支援を落とされる同じディレクトリとしてREADME.md
  • そのHTMLた脆;の変化の影響を受けやすGitHub

のgithubのディレクトリの"プレビューが"HTMLファイルおよび関連ファイル:

.../github/
           readme-preview.html
           github.css
           github2.css
           octicons.eot
           octicons.svg
           octicons.woff

ダウンロードしましたのでCSSとocticonsフォントファイルからのGitHub:

https://assets-cdn.github.com/assets/github- ... .css
https://assets-cdn.github.com/assets/github2- ... .css
https://github.com/static/fonts/octicons/octicons.* (eot, woff, svg)

私に名称変更にCSSファイルを省の長い文字列の六角数字の名をとります。

編集しgithub.cssを参照のコピーのocticonsフォントファイルです。

を検討したHTMLのGitHubのページを再現に十分なHTMLの構造周囲のreadmeファイルコンテンツは、お客様ご自身が所有する単元;例えば、制約のある幅になります。

のGitHub CSS octiconsフォント、HTML"コンテナ"のreadmeファイルのコンテンツに移動目標ずっと作りたいと思っていた定期的にダウンロードしていた。

I toyedを用いたCSSから様々なGitHubます。例えば:

<link rel="stylesheet" type="text/css"
      href="http://rawgit.com/sindresorhus/github-markdown-css/gh-pages/github-markdown.css">

そのためのCSSからGitHubです。

源

ここではHTMLファイルreadme-preview.html):

<!DOCTYPE html>
<!-- Preview a GitHub README.md.
     Copy this file to a directory that contains repo directories.
     Specify a repo name in the query string. For example:

     http://localhost/github/readme-preview.html?myrepo
-->
<html>
<head>
<title>Preview GitHub readme</title>
<meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<!-- Downloaded copies of the CSS files served by GitHub.
     In github.css, the @font-face for font-family:'octicons'
     has been edited to refer to local copies of the font files -->
<link rel="stylesheet" type="text/css" href="github.css"/>
<link rel="stylesheet" type="text/css" href="github2.css"/>
<style>
body {
  margin-top: 1em;
}
</style>
<script type="text/javascript">
//<![CDATA[
var HTTP_STATUS_OK = 200;
var URL_API_GITHUB_RENDER_MARKDOWN = "https://api.github.com/markdown/raw";
var README_FILE_NAME = "README.md";

var repo = location.search.substring(1);

// Get Markdown, then render it as HTML
function getThenRenderMarkdown() {
  var xhr = new XMLHttpRequest();
  xhr.open("GET", repo + "/" + README_FILE_NAME, true);
  xhr.responseType = "text";
  xhr.onload = function(e) {
    if (this.status == HTTP_STATUS_OK) {
     // Response text contains Markdown
      renderMarkdown(this.responseText);
    }
  }
  xhr.send();
}

// Use the GitHub API to render Markdown as HTML
function renderMarkdown(markdown) {
  var xhr = new XMLHttpRequest();
  xhr.open("POST", URL_API_GITHUB_RENDER_MARKDOWN, true);
  xhr.responseType = "html";
  xhr.onload = function(e) {
    if (this.status == HTTP_STATUS_OK) {
      document.getElementById("readme-content").innerHTML = this.response;
    }
  }
  xhr.send(markdown);
}

window.onload = getThenRenderMarkdown;
//]]>
</script>
</head>
<body>
<!-- The following HTML structure was copied from live GitHub page on 2015-12-01,
     except for the "readme-content" id of the article element,
     which was coined for this preview page.-->
<div class="main-content" role="main">
<div class="container repo-container new-discussion-timeline experiment-repo-nav">
<div class="repository-content">
<div id="readme" class="boxed-group flush clearfix announce instapaper_body md">
<h3><span class="octicon octicon-book"></span>README.md</h3>
<article class="markdown-body entry-content"
         itemprop="mainContentOfPage"
         id="readme-content"><p>Rendering markdown...</p></article>
</div>
</div>
</div>
</div>
</body>
</html>
だけでウェブを検索すると、多くの相続人に1を与えます： https://stackedit.io/する

のための Github または Bitbucket テーマは、使用をオンラインエディタ mattstow, url: http://writeme.mattstow.com

のVisual Studioユーザー（ないVS CODE）の場合。

インストールの Markdownを編集する を拡張 スクリーンショット の

この方法は、あなたがREADME.mdを開いたときに右側にライブプレビューを持っています。

の

MarkdownPreview, のプラグイン 雄大なテキスト 以前のコメントの互換性はありませんST2り、サポートするだけでなく 雄大なテキスト3 (春から2018年).

かっきいですでGFM, GitHubの風味の値下げ, 可能なビット以上の定期的勢いこの関連性を知りたければだ .mdsによってGHます。 を含むこのビットの情報のでOPんを追加しGFMタグ自体は、どのようなソリューションのような認識しています。)

で利用することも可能ですのGitHubのAPIの場合はオンラインできる 個人のアクセストークン この目的のためのAPI呼び出せずに認証は限られています。あの詳細は以下を 構文解析GFM のプラグインのdocsに入ります。

あなたがPycharm（またはなどのIntelliJ、ルビーマイン、PHPStorm、のような他のJetBrainsのIDE）を使用している場合は、編集中にリアルタイムプレビューを許可するあなたのIDEでMarkdownをサポート権利のために複数の無料のプラグインがあります。値下げナビゲータープラグインはかなり良いです。あなたはIDEでた.mdファイルを開くと、最近のバージョンはサポートプラグインをインストールし、あなたのリストを表示するために提供されます。

SublimeText2/3

インストールパッケージ: Markdown Preview

オプション:

  • プレビューが表示されます。
  • 輸出ます。
  • コピーをクリップボードへ格納します。

使用 Jupyterラボのます。

、Jupyterラボをインストールするには、ご使用の環境に次のように入力します：

pip install jupyterlab
インストール後に

、あなたの値下げファイルの場所を参照し、ファイルを右クリックし、「開く」を選択し、「Markdownのプレビュー」をクリックします。

Visual Studioのコードについては、私が使用して

Markdownをプレビュー強化拡張。

ReText の良い軽量値下げビューア/エディタです。

の
のReText のライブプレビュー（ソース：ReText;大きなバリアントの画像をクリックして）と

私はそれを答えイジーのおかげで見つけ https://softwarerecs.stackexchange.com /質問/ 17714 /シンプル-値下げ - 視聴者のために、Ubuntuのの（他の回答が他の可能性に言及）

I am using markdownlivepreview:
https://markdownlivepreview.com/

It is very easy, simple and fast.

For those who wish to develop on their iPads, I like Textastic. You can edit and preview the README.md files without an internet connection, once you have downloaded the document from the cloud.

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top