History

Pete Bacon Darwin 293270696b build(docs-infra): render optional decorator options with a ? (#39167 )

Decorator API pages list all their available options in an overview
table and also in a detailed view. Now the rendered syntax of each
option will show a `?` after the name if the option is not required.
This is inline with how class and interface members are rendered.

PR Close #39167

2020-10-07 13:33:26 -07:00

api

build(docs-infra): render optional decorator options with a ? (#39167 )

2020-10-07 13:33:26 -07:00

cli

fix(docs-infra): add deprecated-api-item class to remaining deprecated items (#34192 )

2019-12-05 10:12:11 -08:00

lib

build(docs-infra): display github links in CLI API docs (#26515 )

2018-10-19 11:12:54 -07:00

content.template.html

build(docs-infra): show github edit link on CLI overview (#26515 )

2018-10-19 11:12:53 -07:00

data-module.template.js

build(aio): move the transforms folder into the tools folder

2017-04-16 22:05:23 +01:00

example-region.template.html

build(aio): move the transforms folder into the tools folder

2017-04-16 22:05:23 +01:00

json-doc.template.json

build(aio): move the transforms folder into the tools folder

2017-04-16 22:05:23 +01:00

overview-dump.template.html

refactor(docs-infra): refactor templates (#24378 )

2018-08-31 09:42:10 -07:00

README.md

build(docs-infra): remove legacy jsdoc tag processing (#26039 )

2018-09-24 09:11:02 -07:00

sitemap.template.xml

build(aio): generate sitemap from the generated pages (#21689 )

2018-01-22 12:55:15 -08:00

README.md

This folder contains the dgeni templates that are used to generate the API docs

Generally there is a template for each docType. Templates can extend and/or include other templates. Templates can also import macros from other template files.

Template inheritance

When extending a template, parent must declare blocks that can be overridden by the child. The template extension hierarchy looks like this (with declared blocks in parentheses):

layout/base.template.html (bread-crumbs, header, embedded contents and body)
- package.template.html
- export-base.template.html (short-description, security-notes, deprecation, overview, see-also, details, usageNotes)
  - class.template.html
    - directive.template.html
  - enum.template.html
  - var.template.html
    - const.template.html
    - let.template.html
  - decorator.template.html
  - function.template.html
  - interface.template.html
    - value-module.template.html
  - type-alias.template.html
  - pipe.template.html
  - ngmodule.template.html

Doc Properties

It is useful to know what properties are available on each doc type when working with the templates. The typescript Dgeni package is now written in TypeScript and there is a class for each of the types of API document. See https://github.com/angular/dgeni-packages/tree/master/typescript/src/api-doc-types. This is a good place to go to see what properties you can use in the templates.