github flavored markdown to html
1.0.0
マークダウンをHTMLに変換するために、ユーザーフレンドリーなPython-Moduleとコマンドラインフロントエンド。 Githubs Online Markdown-to-HTML-APIをデフォルトで使用します（インターネット接続が必要です）が、オフライン変換のオプション（GitHubsの動作を密接に模倣）を備えており、他のPythonまたはコマンドラインツールも同様にプラグインできます。使用するものはすべて、より多くの出力オプションと出力オプション、Github-Flavored CSS、Formula Support、Advanced Image Caching and Optimization、ホスト対応のファイルと画像の配置、PDFコンバージョン、絵文字ショートコードサポート、TOCサポートなど、大量の機能で自動的に拡張されます。
その主な目的は、GitHubでホストする場合、静的なWebサイトビルダーまたはGitHubアクションと併せて、Markdownファイルから静的ページを作成することですが、他の目的で非常によく使用することができます。
以下は、その利点と機能の（必ずしも広範囲ではない）リストです。
$ formula- $を使用して使用する）をサポートします。 GH-MD-to-HTMLは、両方が両方ともインストールされている場合（Advantage：Fast、必要はありません）、CodeCogs eqneditor（Advantage：3 GBのラテックスライブラリをインストールする必要はありません）を使用する場合、LaTexとDVISVGMを使用します。[[_TOC_]] 、 {:toc} 、および[toc]を使用するためのオプションのサポートが付属しています。MarkdownをPDFに変換するためのPandocの代替手段を探している場合、ジョブのためにPandocの代わりにGH-MD-to-HTMLを使用したい理由のリストを以下に示します。
Pandocを使用してMarkdownからPDFに変換することは通常、より美しい結果をもたらします（PandocはLaTexを使用します）、GH-MD-to-HTMLには、宿題の割り当てまたはその他の目的のために複雑なファイルを迅速に変換することに関して、独自の利点があります。
$ -SIGNSをコーナリングする白人の量と、フォーミュラが始まるキャラクターを作成することに関して適用されます。ただし、MarkTextのような一般的なマークダウンエディターにはこれらのルールは適用されませんが、エディターで機能したフォーミュラがPandocで変換するときに機能しなくなった場合、多くのフラストレーションにつながります（MarkText自身のExport-To-PDF機能は、フォーミュラヘビーファイルでエラーメッセージなしで失敗する場合があります。最悪の部分は、Pandocが.mdを.pdfに変換することに失敗すると、入力.md-Fileの代わりに中間.tex-Fileに基づいてエラーのライン番号が表示されるため、問題のルートを見つけることが困難になります。ご想像のとおり、GH-MD-to-HTMLは、フォーミュラを開始する空白の量についてあまり気にしませんでした。要約すると、PandocのMD-to-PDFコンバージョンは、画像、ネストされたリスト、マルチライン箇条書きエントリ、またはフォーミュラ、およびGH-MD-to-HTMLに関しては非常に珍しいことです。
pip3 install gh-md-to-htmlを使用して、Pythonパッケージインデックスから直接インストールするか、Windowsにいる場合はpython3 -m pip install gh-md-to-html 。
どちらもLinuxでsudo必要とするかもしれません、そしてあなたはオプションで行うことができます
python3 -m pip install gh-md-to-html[pdf_export]
wkhtmltopdf（v0.12.6以降）をインストールして、オプションのPDFコンバージョン機能を取得し、マークダウンファイルをPDFに変換し、
python3 -m pip install gh-md-to-html[offline_conversion]
オプションのオフラインコンバージョン機能を稼働させるには。
Windowsにいる場合は、 PATH=%PATH%;c:/program files/wkhtmltopdf/binまたは同様のものなど、PDF変換を機能させるために、現在の作業ディレクトリのパスにwkhtmltopdfを追加する必要がある場合があります。
コマンドラインでインターフェイスにアクセスする場合は、ヘルプテキストに文書化された引数をgh-md-to-html （ gh-md-to-html -hでアクセス可能で、以下に示す）を提供することができます。 Windowsでは、 python3 -m gh_md_to_htmlに対応する引数を提供する必要があります。
Python経由でインターフェイスにアクセスする場合は、使用できます
import gh_md_to_html次に、同じ引数（およびデフォルト値）を使用してgh_md_to_html.main()使用します。コマンドラインインターフェイスに提供します。
GitHubのREST APIオフラインによる変換結果の収率のみを模倣したいが、画像キャッシュ、フォーミュラサポート、派手なCSSスタイリングを必要としない場合は、使用してください。
html_as_a_string = gh_md_to_html.core_converter.markdown(your_markdown_as_a_string)
Pythonで。
使用法： gh-md-to-html <input_name> <optional_arguments>
デフォルトの動作：
デフォルトでは、GH-MD-to-HTMLはマークダウンファイル名を引数として受け取り、 .mdの代わりに.htmlを使用して、同じ名前のファイルに生成されたHTMLを保存します。
いくつかの癖：
github-markdown-css/github-css.css （代わりに-Cを追加するために-cを追加）に保存されます。./imagesでキャッシュされ、保存され、参照されています（これを無効にするために-iを追加）。-wを追加）。idおよびファイル内リンクはuser-content-が付いているため、IDの衝突を危険にさらすことなく、生成されたHTMLをより大きなWebサイトに埋め込むことができます。いくつかの一般的なユースケース：
過去の問題を通じて、私はほとんどの人がこのモジュールに持っていると思われる非常に一般的なユースケースがいくつかあることに気付きました。最も一般的なものと、どのオプションとそれらを使用するオプションと議論があります。
-i -w --math false --box-width 25cm使用しますが、グリップはこの目的でより効率的です。--tocを追加します。--math true --emoji-support 0 --dont-make-images-links true 。-i -cを使用してすべてを1つのファイルに配置します。 WebからMarkDownファイルを--origin-typeで変換する：
ローカルマークダウンファイルだけでなく、githubリポジトリ、Webホストのファイル、または文字列の内容を変換することもできます。これらをダウンロードするか、ファイルに保存するだけでは十分ではないことがよくあります。Web上の位置は、参照画像へのリンクを解決する必要があることにも影響するためです。幸いなことに、gh-md-to-htmlがあなたの背中を持っています！
参照した入力を説明するために使用できるさまざまな引数があります。
--origin-type file ：デフォルト。 （相対または絶対）ファイルパスを取得します--origin-type repo ：形式<user_name>/<repo_name>/<branch-name>/<path_to_markdown>.md .mdの形式で、githubリポジトリのマークダウンファイルにpthを取ります。--origin-type web ：WebホストされたMarkdownファイルのURLを取得します。--origin-type string ：マークダウンを含む文字列を取得します。使用するこれらのオプションのいくつかは、マークダウンファイル内の画像リンクが解決される方法に影響します。このReadMeの後のセクションでは、これを詳細に概説しています。どこに行くのかを微調整する：
GH-MD-to-HTMLは、現在のワーキングディレクトリをルートとして、ホスト対応の静的Webサイトを生成することを目的として書かれています。 -w使用してこれを無効にし、生成されたファイルをブラウザで直接表示できることは別として、どこに行くか、そして最も一般的にWebサイトのルートを変更できるものを微調整できる多くのオプションがあります。何らかの理由でそうする必要はないので、必要でない場合は気にしないでください！
--website-root （or -w ）：上記で説明したように、このオプションを空にしておくと、生成されたHTMLファイルをホストしたくない場合に備えて、生成されたHTMLファイルをブラウザで直接プレビューできますが、ウェブサイトとして使用したいディレクトリを提供することもできます。デフォルトは現在の作業ディレクトリになります。--destination （または-d ）：生成されたHTMLファイルが保存される--website-rootに対するパス。デフォルトでは、Webサイトルートがこれに使用されます。--image-paths （or -i ）：上記のように、この空のままにして画像キャッシュを無効にすることができます（ただし、これは、変更した場合には機能しません--origin-type機能しません）。デフォルトはimagesになります。image-paths -Directoryは、GH-MD-to-HTMLの複数の実行間で自動的に空にされていません。--css-paths （または-c ）：外部CSSファイルにCSSを保存することを無効にするために、これを空のままにしてください（上記の1つのファイルのみを変換する場合は有用）、上記のように、Webサイトルートに関連するパスを供給してCSSファイル（ github-css.cssと呼ばれる）が貯蔵される場所を変更します。デフォルトはgithub-markdown-cssです。--output-name （or -n ）：生成されたHTMLファイルをDestination-Directoryに保存するファイル名。この文字列のどこでも<name>を使用でき、Markdownファイルの名前に自動的に置き換えられるため、たとえば、 gh-md-to-html inp.md -n "<name>-conv.html"結果をino-conv.htmlに保存します（これは、 --origin-type stringで動作しません）。-n printを使用して、どこにでも保存するのではなく、stdout（コンソールに印刷）に出力を書き込むだけです。デフォルト値は<name>.htmlであるため、入力ファイル名に適応します。--output-pdf （or -p ）：生成されたpdfを保存するファイル。ここでも<name> -syntaxを使用できます。 -p -optionが使用されていない場合、PDFは生成されません（このオプションが機能するには、上記のPDFKIT＆WKHTMLTOPDFインストール手順に従ってこのオプションが機能する必要があります）が、 <name>.pdfをデフォルトとして使用するために引数なしで-pを使用できます。 PDFとしてのエクスポート：
上記のように、 --output-pdf -Optionを使用して、生成されたHTMLファイルをPDFとしてエクスポートできます。そうすることで、 wkhtmltopdfをインストールし（QTパッチバージョン）、パスに追加する（Windowsにある場合）、 pdfkitをインストールする必要があります（例： pip3 install gh-md-to-html[offline_conversion] ）が、これらの要件はすべて上記で既に概説されています。
ただし、ここには注目に値するものがいくつかあります。まず第一に、 {yourpdfexportdestination}.html 。 {yourpdfexportdestination}は-pに提供されます。このファイルはプロセスで一時的に上書きされるためです。さらに、 -x -optionに信頼できない入力を供給している場合は、 -pまったく使用しないでください。
-pで使用するために特別に調整されたいくつかのオプションもあります。これらは現在です：
--style-pdf （or -s ）：これをfalseに設定して、GitHubのCSSを使用して生成されたPDFファイルをスタイリングすることを無効にします。 GithubのCSSがページの周りに描く境界線は、PDFSで直感に反するように見える可能性があるため、これを行うことをお勧めします。使用するコアマークダウンコンバーターの変更：
GH-MD-to-HTMLは、マークダウンを解析してPDFに変換することに関して、実際にそれほど重いものを持ち上げません。代わりに、Markdown Specに従って基本的な変換を行ういわゆる「コアコンバーター」をラップし、その上に独自のオプション、機能、カスタマイズ、スタイリングを構築します。デフォルトでは、Github Markdown Rest APIはそのために使用されます。これは、GithubがReadmesで行っていることに最も近いためですが、GH-MD-To-HTMLに他の基本的なマークダウンコンバーターを使用することもできます。
GH-MD-to-HTMLには、使用する2つのビルドイン代替コアコンバーターが付属しています。これにより、GitHubのREST APIは、個人的なタッチを追加しながら、できるだけ近いことです。
コアコンバーターを決定するオプション：
--core-converter （または-o ）：このオプションを使用して、デフォルトのオプションとは異なる場合に備えて、いくつかの事前定義されたコアコンバーター（以下を参照）から選択できます。
また、これにbashコマンド（Unix/Linuxシステムで）を提供したり、WindowsでCMD.Exeコマンドを提供することもできます。 {md}は、GH-MD-to-HTMLによってシェルエスケープ入力マークダウンが挿入される場所のプレースホルダーとして存在します。例えば、
gh-md-to-html inp.md -o "pandoc -f markdown -t html <<< {md}"
Pandocをコアコンバーターとして使用します。
また、複数のコマンドを使用してそうすることもできますgh-md-to-html -o "printf {md} >> temp.md; pandoc -f markdown -t html temp.md; rm temp.md" 、
結果がstdoutに印刷されている限り。
Python-InterfaceをGH-MD-to-HTMLに使用する場合は、マークダウン文字列をHTML文字列に変換する関数をこの引数に提供することもできます。
文字列として--core-converterに簡単に供給できる事前定義されたコアコンバーター：
OFFLINE ：GithubのMarkdown Rest APIを模倣しますが、Mistuneを使用してオフラインです。これにはpip3 install gh-md-to-html[offline_conversion]またはpip3 install mistune>=2.0.0rc1を使用して、「Offline_Conversion」のオプションの依存関係が満たされる必要があります。OFFLINE+ ：オフラインと同一に動作しますが、GitHub Rest APIのようにJavaScriptやCSSのような潜在的に有害なコンテンツを削除することはありません。すべてのインラインJS/スタイリングを剥奪せずに、セキュアーチェックされたマークダウンファイルを変換する方法が必要な場合を除き、この機能を使用しないでください！インライン型のサポート：
gh-md-to-html 、デフォルトでインライン式をサポートしています（どのコアコンバーターに関係なく、上記を参照してください）。これは、同じ線に2つのドル記号の間にラテックス式を書くことができることを意味し、その式を表示するSVG画像に置き換えられます。例えば、
$e = m cdot c^2$
Einsteinの有名なフォーミュラをSVG画像として追加し、それを取り巻くテキストの残りの部分をドキュメントに調整します。
gh-md-to-html常にローカルラテックスインストールを使用してこの変換を行います（Advantage：FastとInternetは必要ありません）。ただし、LaTexまたはDVISVGMがインストールされていないか、それらが見つからない場合、これを実現するためにオンラインコンバーター（Advantage：3 GBのLaTexライブラリをインストールする必要はありません）を使用します。
次のオプションを使用して、この動作を変更できます。
--math （or -m ）：これをfalseに設定して、フォーミュラレンダリングを無効にします。--suppress-online-fallbacks ：これをtrueに設定して、フォーミュラレンダリングのオンラインフォールバックを無効にし、要件がローカルにインストールされていないか、何らかの理由で見つからない場合にエラーを上げます。画像キャッシュと画像圧縮：
上記で説明したように、GH-MD-to-HTMLは画像を保存して、同じフォルダーからすべてロードできるようにします。これには利点があります
これらの利点に加えて、GH-MD-to-HTMLを使用すると、これらの画像に使用するレベルの画像圧縮を設定することもできます。そうすることにした場合、すべての画像はJPEGに変換され（好みの背景色と品質設定を使用）、生成されたHTMLがフルサイズで必要とされないと述べている場合、画像はダウンスケーリングされます（ドキュメントで<img> -TAGを使用して、説明的なwidthまたはheight価値を供給することでこれを使用できます）。
GH-MD-to-HTMLは、HTML srcset -Attributeを使用できる唯一のマークダウンコンバーターでもあります。これにより、生成されたドキュメントが同じ画像のいくつかの異なるスケーリングされたバージョンを参照できるようにします。この機能を有効にすると、目に見える画質を犠牲にすることなく、さらにロードされる時間削減につながる可能性があります。これにより、GH-MD-to-HTMLは、画像が多いマークダウンファイルからファーストロードWebサイトを生成する場合に最適な選択肢になります。
これらすべてに使用するオプションは次のとおりです
--compress-images 。
また、次の属性を持つJSONデータの一部を受け入れます。
bg-color ：RGBAイメージをJPEG（RGB-Format）に変換するときに、背景色として使用する色。デフォルトは「 white 」になり、ほぼすべてのHTML5カラーバリュー（「 #FFFFFF 」、「 #ffffff 」、「 white 」、「 rgb(255, 255, 255) 」を受け入れます。progressive ：プログレッシブJPEGとして画像を保存します。デフォルトはfalseです。srcset ：異なるスケーリングされたバージョンの画像を保存し、srcset属性の画像にそれらを提供します。デフォルトはfalseになります。 「 [500, 800, 1200, 1500, 1800, 2000]のショートカットとして機能するさまざまな幅またはTrueの配列を取得します。quality ：画像を保存する品質を記述する0から100の値。デフォルトは90になります。HTMLの特定の画像に対して特定のサイズが指定されている場合、画像は常に適切なサイズに変換されてから品質を低減します。この引数が空のままである場合、圧縮はまったく使用されません。この引数がtrueに設定されている場合、すべてのデフォルト値が使用されます。 JSONデータに設定されており、一部の値が省略されている場合、デフォルトの値はこれらに使用されます。
Python Frontendでこのオプションを使用している場合、JSONデータを含む文字列の代わりにDICTを渡すこともできます。
画像のキャッシュを無効にするために-i使用する場合、明らかな理由で画像圧縮は機能しません。
私の個人的な選択：
Github-Flovored MarkdownとMarkdownは一般にいくつかの不人気な選択を行い、GH-MD-to-HTMLはそれを模倣して、これらの多くを作ります。あなたの目標が（Github-Flovored）Markdownにできるだけ近づいていない場合、そしてGH-MD-to-HTMLが最大限に提供するフルパワーを利用したい場合は、設定とオプションの次の（非常に意見のある）リストをお勧めします。ただし、ユーザーで生成されたコンテンツを変換する場合、これらのいくつかは安全ではないことに注意してください。
--math true ：これは既にデフォルトで有効になっているため、実際には推奨事項ではありませんが、ファイルにLaTex Mathサポートが必要です。--core-converter OFFLINE+ ：これにより、GitHubのREST APIを使用する代わりにマークダウンファイルをオフラインで変換し、インラインコードやマークダウンファイルで希望するすべてのHTMLなどの安全でないものを使用できます。--compress-images ：このオプションを微調整するには多くの方法がありますが、他のMarkdownコンバーターが現在AFAIKをサポートしていないHTML srcset -Attributeの使用など、キャッシュされた画像にいくつかの優れた最適化が可能になります。--box-width 25cm ：生成されたHTMLをより大きなHTMLファイルに埋め込む予定がない限り、生成されたWebサイトのコンテンツが読みやすさの理由で表示されるボックスの幅を制限することをお勧めします。--toc true ：これにより、生成されたファイルの目次のショートカットとして[[_TOC_]]を使用できます。--dont-make-images-links true ：デフォルトでは、githubはすべての画像を画像ソースへのリンクに包みます。このオプションは、画像のリンクをさらに制御するためにこの動作を無効にします。--emoji-support 2 ：gh-md-to-htmlは、次のよう:joy:絵文字ショートコードを使用してサポートします。 --emoji-support 2独自のカスタムemojisを使用できるようにすることでこれをさらに1つに取ります:path/to/funny_image.png: funny_image.png絵文字サイズの絵文字としてテキストに追加します。--soft-wrap-in-code-boxes true ：デフォルトでは、Githubがオーバーフローのリスクがある場合は、水平方向のスクロールバーでマルチラインコードボックスを表示します。このオプションを使用して、代わりにコードボックスに（より合理的な）ソフトラップを使用します。オプションは関連性によって注文されていることに注意してください、そして、それらはすべて賢明なデフォルトを持っているので、何人がいるかに圧倒されないでください。あなたが探している場所を見つけるまでそれらを読むことができ、残りを安全に無視することができます。
ほとんどのオプションはデフォルトの動作をカスタマイズすることを目的としているため、ほとんどのユースケースでは必須ではありません。
usage: __main__.py [-h] [-t {file,repo,web,string}]
[-w WEBSITE_ROOT [WEBSITE_ROOT ...]]
[-d DESTINATION [DESTINATION ...]]
[-i [IMAGE_PATHS [IMAGE_PATHS ...]]]
[-c CSS_PATHS [CSS_PATHS ...]]
[-n OUTPUT_NAME [OUTPUT_NAME ...]]
[-p OUTPUT_PDF [OUTPUT_PDF ...]] [-s STYLE_PDF]
[-f FOOTER [FOOTER ...]] [-m MATH]
[-x EXTRA_CSS [EXTRA_CSS ...]]
[-o CORE_CONVERTER [CORE_CONVERTER ...]]
[-e COMPRESS_IMAGES [COMPRESS_IMAGES ...]]
[-b BOX_WIDTH [BOX_WIDTH ...]] [-a TOC]
MD-origin [MD-origin ...]
Convert markdown to HTML using the GitHub API and some additional tweaks with
python.
positional arguments:
MD-origin Where to find the markdown file that should be
converted to html
optional arguments:
-h, --help show this help message and exit
-t {file,repo,web,string}, --origin-type {file,repo,web,string}
In what way the MD-origin-argument describes the origin
of the markdown file to use. Defaults to file. The
options mean:
* file: takes a relative or absolute path to a file
* repo: takes a path to a markdown-file in a github
repository, such as <user_name>/<repo_name>/<branch-
name>/<path_to_markdown>.md
* web: takes an url to a markdown file
* string: takes a string containing the files content
-w WEBSITE_ROOT [WEBSITE_ROOT ...], --website-root WEBSITE_ROOT [WEBSITE_ROOT ...]
Only relevant if you are creating the html for a static
website which you manage using git or something similar.
--website-root is the directory from which you serve
your website (which is needed to correctly generate the
links within the generated html, such as the link
pointing to the css, since they are all root- relative),
and can be a relative as well as an absolute path.
Defaults to the directory you called this script from.
If you intent to view the html file on your laptop
instead of hosting it on a static site, website-root
should be a dot and destination not set. The reason the
generated html files use root-relative links to embed
images is that on many static websites,
https://foo/bar/index.html can be accessed via
https://foo/bar, in which case relative (non-root-
relative) links in index.html will be interpreted as
relative to foo instead of bar, which can cause images
not to load.
-d DESTINATION [DESTINATION ...], --destination DESTINATION [DESTINATION ...]
Where to store the generated html. This path is relative
to --website-root. Defaults to "".
-i [IMAGE_PATHS [IMAGE_PATHS ...]], --image-paths [IMAGE_PATHS [IMAGE_PATHS ...]]
Where to store the images needed or generated for the
html. This path is relative to website-root. Defaults to
the "images"-folder within the destination folder. Leave
this option empty to completely disable image
caching/downloading and leave all image links
unmodified.
-c CSS_PATHS [CSS_PATHS ...], --css-paths CSS_PATHS [CSS_PATHS ...]
Where to store the css needed for the html (as a path
relative to the website root). Defaults to the
"<WEBSITE_ROOT>/github-markdown-css"-folder.
-n OUTPUT_NAME [OUTPUT_NAME ...], --output-name OUTPUT_NAME [OUTPUT_NAME ...]
What the generated html file should be called like. Use
<name> within the value to refer to the name of the
markdown file that is being converted (if you don't use
"-t string"). You can use '-n print' to print the file
(if using the command line interface) or return it (if
using the python module), both without saving it.
Default is '<name>.html'.
-p OUTPUT_PDF [OUTPUT_PDF ...], --output-pdf OUTPUT_PDF [OUTPUT_PDF ...]
If set, the file will also be saved as a pdf file in the
same directory as the html file, using pdfkit, a python
library which will also need to be installed for this to
work. You may use the <name> variable in this value like
you did in --output-name. Do not use this with the -c
option if the input of the -c option is not trusted;
execution of malicious code might be the consequence
otherwise!!
-s STYLE_PDF, --style-pdf STYLE_PDF
If set to false, the generated pdf (only relevant if you
use --output-pdf) will not be styled using github's css.
-f FOOTER [FOOTER ...], --footer FOOTER [FOOTER ...]
An optional piece of html which will be included as a
footer where the 'hosted with <3 by github'-footer in a
gist usually is. Defaults to None, meaning that the
section usually containing said footer will be omitted
altogether.
-m MATH, --math MATH If set to True, which is the default, LaTeX-formulas
using $formula$-notation will be rendered.
-x EXTRA_CSS [EXTRA_CSS ...], --extra-css EXTRA_CSS [EXTRA_CSS ...]
A path to a file containing additional css to embed into
the final html, as an absolute path or relative to the
working directory. This file should contain css between
two <style>-tags, so it is actually a html file, and can
contain javascript as well. It's worth mentioning and
might be useful for your css/js that every element of
the generated html is a child element of an element with
id xxx, where xxx is "article-" plus the filename
(without extension) of:
* output- name, if output-name is not "print" and not
the default value.
* the input markdown file, if output- name is "print",
and the input type is not string. * the file with the
extra-css otherwise. If none of these cases applies, no
id is given.
-o CORE_CONVERTER [CORE_CONVERTER ...], --core-converter CORE_CONVERTER [CORE_CONVERTER ...]
The converter to use to convert the given markdown to
html, before additional modifications such as formula
support and image downloading are applied; this defaults
to using GitHub's REST API and can be
* on Unix/ any system with a cmd: a command containing
the string "{md}", where "{md}" will be replaced with an
escaped version of the markdown file's content, and
which returns the finished html. Please note that
commands for Unix-system won't work on Windows systems,
and vice versa etc.
* when using gh-md-to- html in python: A callable which
converts markdown to html, or a string as described
above.
* OFFLINE as a value to indicate that gh-md-to-html
should imitate the output of their builtin
md-to-html-converter using mistune. This requires the
optional dependencies for "offline_conversion" to be
satisfied, by using `pip3 install
gh-md-to-html[offline_conversion]` or `pip3 install
mistune>=2.0.0rc1`.
* OFFLINE+ behaves identical to OFFLINE, but it doesn't
remove potentially harmful content like javascript and
css like the GitHub REST API usually does. DO NOT USE
THIS FEATURE unless you need a way to convert secure
manually-checked markdown files without having all your
inline js stripped away!
-e COMPRESS_IMAGES [COMPRESS_IMAGES ...], --compress-images COMPRESS_IMAGES [COMPRESS_IMAGES ...]
Reduces load time of the generated html by saving all
images referenced by the given markdown file as jpeg.
This argument takes a piece of json data containing the
following information; if it is not used, no compression
is done:
* bg-color: the color to use as a background color when
converting RGBA-images to jpeg (an RGB-format). Defaults
to "white" and accepts almost any HTML5 color-value
("#FFFFFF", "#ffffff", "white" and "rgb(255, 255, 255)"
would've all been valid values).
* progressive: Save images as progressive jpegs. Default
is False.
* srcset: Save differently scaled versions of the image
and provide them to the image in its srcset attribute.
Defaults to False. Takes an array of different widths or
True, which serves as a shortcut for "[500, 800, 1200,
1500, 1800, 2000]".
* quality: a value from 0 to 100 describing at which
quality the images should be saved (this is done after
they are scaled down, if they are scaled down at all).
Defaults to 90. If a specific size is specified for a
specific image in the html, the image is always
converted to the right size. If this argument is left
empty, no compression is down at all. If this argument
is set to True, all default values are used. If it is
set to json data and values are omitted, the defaults
are also used. If a dict is passed instead of json data
(when using the tool as a python module), the dict is
used as the result of the json data.
-b BOX_WIDTH [BOX_WIDTH ...], --box-width BOX_WIDTH [BOX_WIDTH ...]
The text of the rendered file is always displayed in a
box, like GitHub READMEs and issues are. By default,
this box fills the entire screen (max-width: 100%), but
you can use this option to reduce its max width to be
more readable when hosted stand-alone; the resulting box
is always centered. --box-width accepts the same
arguments the css max-width attribute accepts, e.g. 25cm
or 800px.
-a TOC, --toc TOC Enables the use of `[[_TOC_]]`, `{:toc}` and `[toc]`
at the beginning of an otherwise empty line to create a
table of content for the document. These syntax are
supported by different markdown flavors, the most
prominent probably being GitLab-flavored markdown
(supports `[[_TOC_]]`), and since GitLab displays its
READMEs quite similar to how GitHub does it, this option
was added to improve support for GitLab- flavored
markdown.
上記のように、Markdownファイルで参照されている画像は、ローカルに保存され、生成されたHTMLのルート関連ハイパーリンクを使用して参照されます。コンバーターが画像の位置を推測する方法は、次の表に示されています。上部に記載されているImageLinkのタイプと、左に記載されている入力マークダウンのタイプ：
https://またはhttp:// | 腹筋。 filepath | rel。 filepath | / （Eg /imagedir/image.png ）から始める | / （例えばimagedir/image.pngなど）から始めていない | |
|---|---|---|---|---|---|
-t file | アドレスから | 腹筋。 filepath | rel。 filepath（ .md -fileが嘘をつく場所から） | - | - |
-t string | アドレスから | abs.filepathですが、セキュリティ上の理由で確認が必要です | rel。 filepath（ツールが呼び出される場所）が、セキュリティ上の理由で確認が必要です | - | - |
username/repo/dir/file.md -t repo | アドレスから | - | - | username/repo/imagedir/image.png | username/repo/dir/imagedir/image.png |
https://foo.com/bar/baz.md -t web | アドレスから | - | - | https://foo.com/image.png | https://foo.com/bar/image.png |
私のすべてのプロジェクトと同様に、フィードバック（それが私のプロジェクトのユースケースを教えてくれたり、Readmeの構造が好きではないことを教えたり、特定の機能を特に気に入っていることを教えてくれたことを教えてくれたとしても、このプロジェクトをより良くするのに役立ちます。フィードバック、ショートおよび非フォーマルで問題を削除することも、何らかの理由で問題を提起したくない場合もメールで送信できます。私は現時点では将来機能を追加するつもりはありませんが、私は常に既存の機能、ドキュメンテーションなどを修正して調整することにオープンです。
Githubの問題に関しては、一般的に非常に反応します。私はそれらを非常に真剣に考えて、できるだけ早く解決しようとします。バグ、奇妙な動作、インストールエラーなどに遭遇した場合は、私のツールを使用している間、問題で私に言うことをheしないでください。
このツールが便利だと思った場合は、Githubで主演することを検討して、感謝を示してください。また、コードのコピーで自分のコピーで修正できたとしても、遭遇した問題について教えてくれた場合は、このレポでも修正できます。
gh-md-to-html使用する方法について（私による）より良い説明（MDからPDFへの変換に関する要点の下）：リンクgh-md-to-htmlの簡単な言及アイコンは製造されました
.md-file.icon：flaticon.comのFreepik
.md-file.icon：flaticon.comのFreepik
Arrow-Icon：Dave GandyのFont Awesome、Creative Commons Attribution-Share Solike 3.0 Unportedでライセンス
Github-Icon：IconscoutのGithubアイコン
免責事項：このモジュールは、Githubによって書かれたものではなく、GithubでサポートされているGithubでサポートされている、Githubを搭載したり、Githubに所属したりするGithubで承認されていません。 GitHubが提供するPublic APIと、MITライセンスの下でGitHubがライセンスした.CSSファイルのみを使用します。
