600402d440
All the docs related files (docs-app, doc-gen, content, etc)
are now to be found inside the `/aio` folder.
The related gulp tasks have been moved from the top level
gulp file to a new one inside the `/aio` folder.
The structure of the `/aio` folder now looks like:
```
/aio/
build/ # gulp tasks
content/ #MARKDOWN FILES for devguides, cheatsheet, etc
devguides/
cheatsheets/
transforms/ #dgeni packages, templates, etc
src/
app/
assets/
content/ #HTML + JSON build artifacts produced by dgeni from /aio/content.
#This dir is .gitignored-ed
e2e/ #protractor tests for the doc viewer app
node_modules/ #dependencies for both the doc viewer builds and the dgeni stuff
#This dir is .gitignored-ed
gulpfile.js #Tasks for generating docs and building & deploying the doc viewer
```
Closes #14361
|
||
|---|---|---|
| .. | ||
| includes | ||
| layout | ||
| lib | ||
| README.md | ||
| api-list-audit.template.json | ||
| api-list-data.template.json | ||
| cheatsheet.template.json | ||
| class.template.html | ||
| const.template.html | ||
| content.template.html | ||
| data-module.template.js | ||
| decorator.template.html | ||
| directive.template.html | ||
| enum.template.html | ||
| example-region.template.html | ||
| function.template.html | ||
| interface.template.html | ||
| json-doc.template.json | ||
| let.template.html | ||
| module.template.html | ||
| overview-dump.template.html | ||
| pipe.template.html | ||
| type-alias.template.html | ||
| var.template.html | ||
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 (base)
- module.template.html
- layout/api-base.template.html (jumpNav, jumpNavLinks, whatItDoes, infoBar, securityConsiderations, deprecationNotes, howToUse, details)
- 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
- type-alias.template.html
- pipe.template.html
- class.template.html
Doc Properties
It is useful to know what properties are available on each doc type when working with the templates. Here is an overview:
class
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
- members
directive
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
- members
enum
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
var
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
const
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
let
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
decorator
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
- members
function
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
interface
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
- members
type-alias
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented
pipe
- docType
- name
- id
- moduleDoc
- path
- description
- notYetDocumented