2011-07-14 32 views
2

私たちはMarkdownにソフトウェアドキュメントを書くつもりですが、Markdownドキュメントを見栄えの良いHTMLページに変換するためにクリック可能なWebビューを提供する予定です。Markdownを簡単なHTML文書に変換する簡単な方法はありますか?

私たちのワークフローでは、ドキュメンテーションを書いて、ソースコードとバイナリと一緒にドキュメンテーションをクライアントに配信する傾向があります。私は1ページ分のHTMLプログラムに変換することが多いと分かったが、マークダウンページとスタイリング要素を取り、サブページなどのナビゲーション要素を含む実行可能なサイトに変換できる優れたコンバータがあるのだろうかと思う。 ?

+0

MarkdownをreStructuredTextに置き換えることができれば(もう少し高度な構文であれば非常によく似ています)、Sphinxシステムを使用することができます:http://sphinx.pocoo.org/ –

答えて

0

これはエンドユーザー向けのドキュメントですか、開発者向けのAPIドキュメントですか?

最初のケースでは、MarkdownサポートでWikiソフトウェアを調べることをお勧めします。

2番目のケースでは、実際にはどのプログラミング言語について言及するべきですか。

+0

主なエンドユーザインストール手順やデザインドキュメントなどのドキュメント。 – Marco

0

Gollumを確認してください。 Githubのwikiを動かすソフトウェアです。これは、テキストファイルのgitリポジトリをwikiに変換します。

+0

ゴラムは素敵ですが、私たちはGitHubに自分のものを保存しないので、ゴラムを使用しているのは当然です。 – Marco

0

ここには、blogがあります。このツールでは、Markdownでドキュメントを管理するツールがいくつか紹介されています。 ScreenStepsはあなたに一番合っているようです。

関連する問題