我正在建设一个网站,我想有我的文档内置到该网站。
例如,如果我使用JSDoc为javascript生成文档,我会得到自动生成的文件,我可以只更改模板以只输出内容。
我想为这些自动生成WordPress页面。
我有一个自定义的post类型,它是component,因此我希望它能像这样工作:
component/component-name/docs/0.0.0/page-name
我可以手动执行此操作,但有一系列组件,让每个版本都自动包含文档会更容易。
<小时>EDIT
我想到的一些事情:
Idea 1 ) 向url添加额外的参数,并添加包含文档的文件夹。从文件夹中拉出html并显示在页面上。本质上像伪rest api一样使用它
- Pros: 不必处理生成页面的问题,文档会自动显示最新的上载。
- Cons: 无法在WordPress内搜索
Idea 2 ) 有一个脚本可以遍历docs文件夹中的所有文件并以编程方式生成页面。
SO网友:jgraup
WordPress允许您添加help tabs 显示在仪表板和每个管理页面上。
$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 可以帮助从DockBlocks创建PHP文档并以HTML格式呈现。
还有其他各种插件,如WP Help 和Documentor 这可能会有所帮助。
但这就像你想要一个生活方式指南this 或this.
您最好的选择是坚持使用帮助选项卡并在其他地方链接到自动生成的页面,或者将您的文档作为book.