内部 (公開されていない) ソフトウェア アプリケーション用の見栄えがよく、保守が容易なユーザー マニュアルを作成しようとしています。
大まかな要件は次のとおりです。
- ユーザーが参照するドキュメントは、静的な HTML ページになります。
- ドキュメントは、ユーザーのハード ドライブから参照できる必要があります。ページはWeb サーバーでは提供されません。別の言い方をすれば、ユーザーのハード ドライブには最上位のdocディレクトリがあり、そこに最初のindex.htmlが含まれ、次に残りのコンテンツを含むディレクトリ ツリー構造が続きます。ユーザーは自分のハード ドライブからそのindex.htmlをダブルクリックして開始でき、他のコンテンツ (ページ、画像、ビデオなど) のほとんど (すべてではないにしても) もユーザーのデバイスにあります。
- サイトの基本的なレイアウトは、左側のペインにユーザー マニュアルの目次を表示し、右側にセクションのコンテンツを表示する必要があります。
- 生のコンテンツを維持しやすいものにしたいと思います。私は Markdown を考えていますが、もっと良いものがあれば、他の提案を受け入れます。ただし、Markdown は非常に単純に見えるので、未加工のコンテンツとしてはかなり適しているように思えます。ユーザー マニュアルの開発者は、HTML や CSS を知らなくてもコンテンツを追加できるはずです。
を。「何か」を実行して、未加工のコンテンツから見栄えの良い CSS が適用された HTML に HTML を生成します。
このようなものはすでに存在しているように感じますが、それを見つけるための適切な検索キーワードを思い付いていないようです.
現在、私は静的サイトジェネレーターをいじっていて、結果がやや複雑です。私はまだそれらの多くをいじっていません - 私は Hugo ( https://gohugo.io/ ) に出くわし、それをいじっています。Hugoのうさぎの穴を下っていくと、四角いペグ/丸い穴の問題が時々発生するようです. 私の正確なユースケースではないので、ユーザーのデバイスから動作させるのに少し苦労しました。また、生のコンテンツがどのようにレイアウトされ、出力 HTML ツリー構造をどのように構築するかについての手掛かりにも非常に敏感であるようです。その一部は、私の学習曲線の問題に過ぎないと確信しています (私は Web 開発者ではありません。しかし、実際にコンテンツを作成するだけでなく、Hugo が HTML をレンダリングする理由/方法を理解するために多くの時間を費やしているように感じることがあります。
また、Doxygen を使用してユーザー マニュアルを生成することについて、オンライン (特にUser manual with Doxygen ) でゴロゴロしているのを見たことがありますが、実際にそれをやってのける方法についての良い例は見つかりませんでした。私たちはすでに Doxygen を使用してコードを文書化しています。これは、開発者が把握するツールの依存関係/学習曲線が 1 つ少なくなるため、優れたソリューションになる可能性があります。
好きなように似たようなことをするために見つけた解決策はありますか?