8

ドキュメントの作成

開発者として、私はドキュメントを作成および更新する最も簡単な方法を探していました。「私を読まないでください」と叫ぶ退屈なテキストではなく、コードのサポートが非常に簡単な、楽しく (そして簡単に) フォーマットされたものです。

LaTeX から wiki、Markdown に至るまで、ほんの数例を挙げると、Markdown はそれに近いものになっていると思います。しかし、ドキュメント自体は非常にオタク的で、あまり移植性がありません。これは、HTML および PDF にする必要があります。

マークダウン エディター

基本的に私は、このドキュメントを HTML と PDF に変換するためのエディター、コンバーター、または思いもよらなかった巧妙なトリックを探しています。

私が見つけた最も単純なエディターは間違いなくStackEditですが、HTML をうまくエクスポートできません。適切にリンクされていないオンライン スタイルシートに依存しており、エクスポートされた HTML は非常に見にくいものです。とにかく、オフラインでは機能しません。

HTML と PDF のエクスポート

これを適切に行う方法を探しています。markdownファイルを適切な HTML に変換するスタンドアロンのアプリケーションまたはスクリプトが存在するかどうかは気にしません。私が見つけられないドキュメント生成の秘訣を教えてくれる人が必要です。

PDFは別の話です。HTML から PDF へのコンバーターでコンピューターをいっぱいにスパムしたと思います。

4

5 に答える 5

1

Doxygenを検討しましたか? Doxygen は複数の形式で出力します (必要に応じて一度に)。私は通常、HTML マニュアルを生成するために使用します。

Doxygen は主にコードを文書化するために設計されていますが、スタンドアロンのマニュアルを書いているだけであれば、ページとセクションに関連するコマンドはかなりうまく機能します。

Doxygen の出力形式の一覧はこちらです。

Doxygen マニュアルページの詳細:

make pdfPDF:出力ディレクトリで実行することにより、LaTeX 出力から生成されます。PDF 出力を改善するには、通常、構成ファイルで USE_PDFLATEX を YES に設定して、pdflatex の使用を有効にする必要があります。PDF ファイルでハイパーリンクを取得するには、PDF_HYPERLINKS も有効にする必要があります。

注: これを使用するには、TeX のセットアップが必要です。Doxygen だけでは必要な出力が生成されませんが、これはPandocにも当てはまります。

于 2013-11-05T14:27:38.920 に答える