honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-cn/aio/tools/transforms/templates/README.md

33 lines
1.4 KiB
Markdown
Raw Normal View History

build(aio): remove formatting and styles from dgeni templates Much of the formatting was hardcoded and copied from the old anguar.io jade files. This gives us a clean start. Also, more use has been made of include files to make the templates easier to understand and manage.
2017-01-27 09:51:41 -05:00
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):
build(docs-infra): remove legacy jsdoc tag processing (#26039) PR Close #26039
2018-09-20 09:28:18 -04:00
- 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)
build(aio): remove formatting and styles from dgeni templates Much of the formatting was hardcoded and copied from the old anguar.io jade files. This gives us a clean start. Also, more use has been made of include files to make the templates easier to understand and manage.
2017-01-27 09:51:41 -05:00
- class.template.html
- directive.template.html
build(docs-infra): remove legacy jsdoc tag processing (#26039) PR Close #26039
2018-09-20 09:28:18 -04:00
- enum.template.html
build(aio): remove formatting and styles from dgeni templates Much of the formatting was hardcoded and copied from the old anguar.io jade files. This gives us a clean start. Also, more use has been made of include files to make the templates easier to understand and manage.
2017-01-27 09:51:41 -05:00
- var.template.html
- const.template.html
- let.template.html
- decorator.template.html
- function.template.html
- interface.template.html
build(docs-infra): remove legacy jsdoc tag processing (#26039) PR Close #26039
2018-09-20 09:28:18 -04:00
- value-module.template.html
- type-alias.template.html
build(aio): remove formatting and styles from dgeni templates Much of the formatting was hardcoded and copied from the old anguar.io jade files. This gives us a clean start. Also, more use has been made of include files to make the templates easier to understand and manage.
2017-01-27 09:51:41 -05:00
- pipe.template.html
build(docs-infra): remove legacy jsdoc tag processing (#26039) PR Close #26039
2018-09-20 09:28:18 -04:00
- ngmodule.template.html
build(aio): remove formatting and styles from dgeni templates Much of the formatting was hardcoded and copied from the old anguar.io jade files. This gives us a clean start. Also, more use has been made of include files to make the templates easier to understand and manage.
2017-01-27 09:51:41 -05:00
# Doc Properties
It is useful to know what properties are available on each doc type when working with the templates.
docs(aio): high-level documentation of the `transforms` folder (#18151) PR Close #18151
2017-07-15 12:31:48 -04:00
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.