redtape

redtapeはシンプルな、魅力的なHTMLドキュメントを生成するために、githubの味のマークダウンを使用して集中ドキュメントジェネレータです。それは、自動的にTwitterのブートストラップと統合し、シンプルな、魅力的なスタイリングを備えています。 redtapeをdに触発さが、それでもユーザーは、高度なカスタマイズに自分の出力文書をスタイルとコントロールを可能にしながらシンプルなインターフェイスを持ってしようとしている。
のインストールの
あなたがLinuxやOSX上にある場合は、インストールするピップを使用することができます。
> redtapeをインストールピップ
どのredtapeとその依存関係をインストールします。
の使用法の
使用するには、ドキュメントの完全なドキュメントまたはディレクトリ上でRTを実行します。ディレクトリ上で実行する場合は、RTは（.md、.mdown、または.markdown拡張子）すべての値下げファイルのHTMLファイルを作成します。
> RT mydocument.md
> RTのドキュメント/
の資産の
デフォルトでは、RTは、これらの文書にリンクを室温資産を持って、そこからファイルを提供する場所を設定していると想定しています。あなたが使用する各資産の/ .. {JS、CSS、IMG} /資産/：レイアウトはredtapeリポジトリ内の資産ディレクトリとまったく同じです。あなたがredtapeのデフォルトの資産を使用したい場合は、簡単に実行することで、現在のディレクトリに、適切なアセットディレクトリを作成することができます。
> RT --create-資産
あなたが単一のドキュメントモードで実行しているか、あなたのHTML文書のための最終的なホスト上の資産のディレクトリを設定したくない場合は、--embed使用して文書で使用される各アセットを埋め込むことがredtapeを指示することができます。
> RT --embed mydocument.md
ジャバスクリプト
デフォルトでは、redtapeの実行には、任意のJavaScriptを必要としない、と--embedモードでいずれかを埋め込むことはありません。 --prettifyオプションを選択した場合、のライブラリーではなくではソースコードの強調表示ソースで使用される、及び--prettifyと--embed両方を使用する場合、それは自動的に埋め込まれる。飾り立てるグーグル
Redtapeは、単純な単一ページのjavascriptのデモンストレーションに適しており、--use-JSが有効になっている場合、redtapeはjQueryとブートストラップのJavaScriptライブラリが含まれます。
のカスタマイズ出力の
出力をカスタマイズするさまざまな方法で行うのは簡単である。非埋め込み文書のための資産のCSSを変更することに加えて、あなたはまた、ヘッダーとフッターを追加することができたり、redtapeのデフォルトのテンプレートに基づいてカスタムドキュメントテンプレートを使用します。
ヘッダーとフッター
あなたがカスタマイズされた文書のヘッダーを持っているか、あなたがあなたのドキュメントに追加したいフッター場合は、ヘッダーとフッターなどの設定で使用されるあなたがレンダリングされているベースディレクトリまたは設定されたデフォルトのパスにheader.htmlが及びfooter.htmlのドキュメントを追加することができますどちらか。デフォルトでは、これらは、それぞれ、文書の上下に配置される。
ドキュメントのサンプルセットは次のようになります。
> LSのmydocsと/
mydocsと/ index.md mydocsと/ simple.md mydocsと/ advanced.md
mydocsと/ header.htmlがmydocsと/ footer.htmlの
RT mydocsとレンダリングmydocsと、ディレクトリ内の各文書のヘッダーとフッターを使用します。
カスタムテンプレート
あなたは非常に特殊な要件がある場合は、独自のドキュメントテンプレートを作成し、出力を完全にコントロールすることができます。 Redtape、テンプレートをDjangoのに似て広く使用されているテンプレートシステム事前パースのテンプレートエンジンを使用しています。変数がテンプレートに利用可能であるかの簡単なアイデアを得るために--context引数を指定してredtapeを実行します。
またredtapeのデフォルトテンプレートの名前ですbasic.jinja、から継承することができます。このテンプレートは、基本的なCSSとredtapeのJavaScriptの機能を維持し、あなたは、たとえば、中に明確な文書本体を作ることを可能にする二つのブロック、頭と体を定義します。両方の上書き標準のHTML5の文書構造であなたを残します。
あなたは--template、-tで使用またはcustom.htmlまたはcustom.jinjaなどのドキュメントディレクトリに配置するカスタムテンプレートを指定することができます。

の要件の：ます。

• のPythonます。