Markdocは、技術文書、マニュアル、社内プロジェクトのwiki、または静的サイトの世代のために優れています。
技術ドキュメント/マニュアルについては、Markdocは、ソフトウェアのための手書きガイドとマニュアルを作成し、レンダリングするために使用することができます。このようなドキュメントは、通常、自動生成されたAPIドキュメントから分離され、単独のAPIドキュメントよりも高いレベルのビューを与えるかもしれません。これは、Web /デスクトップアプリケーションのためのクライアントのマニュアル、またはフレームワークのためであっても、開発者向けドキュメントに使用される可能性があります。
内部プロジェクトのWikiについては、Markdocのウィキは、ページごとに単一のプレーン・テキスト・ファイルで構成されています。 (そのようなMercurialのやGitのような)DVCSでWikiを組み合わせることで、あなたはいくつかの他の人と協力することができます。追跡、共有、相互に変更をマージし、ウィキ&rsquoを表示するには、DVCSを使用します。歴史を。
静的サイト生成のために、Markdocは生のHTMLファイルやメディアへのwikiに変換します。これは、あなたはおそらく、カスタムCSSスタイルで、ブログ、個人のウェブサイトやMarkdocのwikiのページのコレクションを管理することを可能にし、ウェブサイトにレンダリングされたHTMLを公開します。結果として得られるHTMLは完全に独立しているのでMarkdocは、ホスティングサイトにインストールする必要はありません
この特長:
この設定の一行にGoogle Analyticsのトラッキングを設定します。
ちょうどそれらでMarkdown記法形式のテキストファイルとディレクトリのように見えベアボーンウィキを調べることができます。
内蔵のHTTPサーバとWSGIアプリケーション単一のコマンドでコンパイルされたウィキを提供するために。
連続は(rsyncを経由して)を構築するサーバがMarkdocのwikiを再コンパイルしながら実行し続けることができますを意味します。ただ、変更を確認するには、ブラウザを更新します。
単一の設定パラメータを使用してMarkdocのwikiに強調表示Pygments搭載の構文を追加します。
Markdocは、パブリックドメインのソフトウェアです。それは、常に使用して完全に自由になり、あなたは帰属またはencumberancesなしで(オープンソース、プロプライエタリまたはそうでなければ)どのような状況の下で(一部または全部)を再配布することができます。
この要件:
このargparse
CherryPyに
Jinja2の
値下げ
Pygments
PyYAML
webob
Pythonの2.4またはそれ以上
rsyncの
コメントが見つかりません