如何定义ngdoc根/概述页面?

时间:2015-06-02 12:33:29

标签: angularjs ngdoc

我有一个包含 API文档部分和教程部分的工作文档页面。当我在痕迹导航栏中单击 Tutorial 时,内容区域中会出现一个空白页面,浏览器标题栏会显示" core-js:错误:找不到页面!"。对于 API文档按钮,可以观察到相同的行为。

单击主导航栏链接(或主要面包屑项目)时将加载哪个文件?如何在Gruntfile.js中配置此行为?

我使用Firefox开发工具来监控相应文件的ajax请求,但是当我点击 Tutorial 链接时看不到请求。 我在Gruntfile.js中尝试了几个选项并尝试放置一个 tutorial.html文件到我生成的文档目录中 - 没有成功。

是否无法在根部分的页面上放置内容?

我点击了grunt任务,在点击主导航栏的项目链接 core-js 时打开 Intro 页面,我会很感激< em> Tutorial 链接,但我希望有一个特定的 Tutorial 页面。

我当前的Gruntfile代码:

ngdocs: {
    options: {
        dest: 'doc/generated',
        html5Mode: false,
        startPage: '/tutorial/intro',
        title: 'core-js',
        titleLink: '/#/tutorial/intro',
        bestMatch: true
    },
    api: {
        title: 'API Documentation',
        src: config.doc.files.api
    },
    tutorial: {
        title: 'Tutorial',
        src: config.doc.files.tutorial
    }
}

1 个答案:

答案 0 :(得分:1)

我假设config.doc.files.api设置为文件名数组。只是为了确定,它应该解决为:

api: {
   title: 'API Documentation',
   src: ['./foo.js', 'bar.js']
}

文件路径相对于grunt文件。 要创建概述页面,只需创建一个文件(例如&#39; tutorial.txt&#39;):

/**
 * @ngdoc overview
 * @name index
 * @description your text here
 */

并将文件添加到src部分的api数组。