web-dev-qa-db-ja.com

どのようにしてドキュメントをワードプレスに取り込むのですか？

私はサイトを構築しています、そして私は自分のドキュメントをそのサイトに組み入れたいです。

たとえば、JavaScript用のドキュメントを生成するためにJSDocを使用すると、自動生成されたファイルが取得されます。コンテンツを出力するようにテンプレートを変更するだけで済みます。

これらのWordPressページを自動的に生成したいです。

私はコンポーネントであるカスタム投稿タイプを持っているので、私はそれがこのような何かを働かせたいと思います：

component/component-name/docs/0.0.0/page-name

私は手動でこれを行うことができましたが、たくさんのコンポーネントがあり、各リリースに自動的にドキュメントが組み込まれるようにする方が簡単でしょう。

EDIT

私が念頭に置いていることのいくつか：

アイデア1）URLとドキュメントを含むフォルダに追加の引数を追加します。 htmlをフォルダから外してページに表示します。疑似休憩apiのように本質的にそれを使用する

  • 長所：ページを生成する必要はありません。ドキュメントには最新のアップロードが自動的に表示されます。

  • 短所：WordPress内で検索できません

アイデア2）docsフォルダー内のすべてのファイルを横断し、プログラムによってページを生成するスクリプトを作成します。

  • 長所：WordPress内で検索可能

  • 短所：変更した場合は、おそらくページを削除して再生成する必要があります。おそらく、お尻が痛くなることもあります。

WordPressがどのようにして自身のコーデックスサイトを運営しているのかを誰かが知っていて、大規模ではあるが自動化されているものの方向性を私に示すことができれば、それは非常にいいことです。

pagesautomationdocumentation
1
brianxautumn

WordPressでは、ダッシュボードと各管理ページに表示される ヘルプタブ を追加できます。

$screen = get_current_screen();

$screen->add_help_tab( array( 

   'id' => $id,            //unique id for the tab
   'title' => $title,      //unique visible title for the tab
   'content' => $content,  //actual help text
   'callback' => $callback //optional function to callback

) );

APIGen または PHPDoc を使用すると、PHPを簡単に作成できます。あなたのDockBlocksからドキュメントを作成し、HTMLとしてレンダリングします。

WPヘルプ や Documentor のような他のさまざまなプラグインが役に立ちます。

しかし、 this や this のような生活スタイルガイドがほしいのと同じようなものです。 。

あなたの最善の策は、ヘルプタブに固執して他の場所にあなたの自動生成されたページにリンクすることです - あるいは 本としてあなたのドキュメントをする 。

2
jgraup