首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何定义ngdoc根/概述页面?

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

Stack Overflow用户
提问于 2015-06-02 12:33:28
回答 1查看 237关注 0票数 2

我有一个包含API文档部分和教程部分的工作文档页面。当我单击面包屑导航中的教程时,内容区域会出现一个空白页面,浏览器标题栏上写着"core-js: Error: page Not!“。API文档按钮也可以观察到相同的行为。

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

我使用Firefox开发工具监视对应文件的ajax请求,但单击教程链接时看不到请求。我尝试了Gruntfile.js中的几个选项,并尝试将一个tutorial.html文件放置到我生成的文档目录中--但没有成功。

在根部分的页面上不可能有内容吗?

当点击主导航栏的项目链接核心-js时,我配置了grunt任务来打开Intro页面,我会欣赏教程链接的这种行为,但是我更希望有一个特定的教程页面。

我当前的Gruntfile代码:

代码语言:javascript
复制
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
    }
}
EN

回答 1

Stack Overflow用户

发布于 2016-10-14 03:07:53

我假设config.doc.files.api被设置为一个文件名数组。可以肯定的是,它应该解决如下问题:

代码语言:javascript
复制
api: {
   title: 'API Documentation',
   src: ['./foo.js', 'bar.js']
}

文件路径相对于grunt文件。要创建一个概览页面,只需创建一个文件(例如“tutorial.txt”):

代码语言:javascript
复制
/**
 * @ngdoc overview
 * @name index
 * @description your text here
 */

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

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/30596231

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档