2017-07-15 12:31:48 -04:00
|
|
|
# Overview
|
2017-01-26 09:03:53 -05:00
|
|
|
|
2017-07-15 12:31:48 -04:00
|
|
|
All the content that is rendered by the AIO application, and some of its configuration files, are generated from source files
|
|
|
|
|
by [Dgeni](https://github.com/angular/dgeni). Dgeni is a general purpose documentation generation tool.
|
2017-01-26 09:03:53 -05:00
|
|
|
|
2017-07-15 12:31:48 -04:00
|
|
|
Markdown files in `/aio/content`, code comments in the core Angular source files and example files are processed and transformed
|
|
|
|
|
into files that are consumed by the AIO application.
|
2017-01-26 09:03:53 -05:00
|
|
|
|
2017-07-15 12:31:48 -04:00
|
|
|
Dgeni is configured by "packages", which contain services and processors. Some of these packages are installed as `node_modules`
|
|
|
|
|
from the [dgeni-packages](https://github.com/angular/dgeni-packages) and some are specific to the AIO project.
|
2017-01-26 09:03:53 -05:00
|
|
|
|
2017-07-15 12:31:48 -04:00
|
|
|
The project specific packages are stored in the `aio/tools/transforms` folder. See the [README.md](plunker-builder/README.md)
|
|
|
|
|
for more details.
|
2017-01-26 09:03:53 -05:00
|
|
|
|
2017-07-15 12:31:48 -04:00
|
|
|
If you are an author and want to know how to generate the documentation, the steps are outlined in the top level
|
|
|
|
|
[README.md](../../README.md#guide-to-authoring).
|
2017-01-26 09:03:53 -05:00
|
|
|
|
2017-07-15 12:31:48 -04:00
|
|
|
## Root packages
|
2017-01-26 09:03:53 -05:00
|
|
|
|
2017-07-15 12:31:48 -04:00
|
|
|
To run Dgeni, you must specify a root package, which acts as the entry point to the documentation generation.
|
|
|
|
|
This root package, in turn requires a number of other packages, some are defined locally in the `tools/transforms` folder,
|
|
|
|
|
such as `tools/transforms/cheatsheet-package` and `tools/transforms/content-package`, etc. And some are brought in from the
|
|
|
|
|
`dgeni-packages` node modules, such as `jsdoc` and `nunjucks`.
|
2017-01-26 09:03:53 -05:00
|
|
|
|
2017-07-15 12:31:48 -04:00
|
|
|
* The primary root package is defined in `tools/transforms/angular.io-package/index.js`. This package is used to run a full
|
|
|
|
|
generation of all the documentation.
|
|
|
|
|
* There are also root packages defined in `tools/transforms/authors-package/*-package.js`. These packages are used by the
|
|
|
|
|
documentation authors when writing docs, since it allows them to run partial doc generation, which is not complete but is
|
|
|
|
|
faster for quickly seeing changes to the document that you are working on.
|
|
|
|
|
|
|
|
|
|
## Other packages
|
|
|
|
|
|
|
|
|
|
* angular-base-package
|
|
|
|
|
* angular-api-package
|
|
|
|
|
* angular-content-package
|
|
|
|
|
* content-package
|
|
|
|
|
* examples-package
|
|
|
|
|
* links-package
|
|
|
|
|
* post-process-package
|
|
|
|
|
* remark-package
|
|
|
|
|
* target-package
|
|
|
|
|
|
|
|
|
|
## Templates
|
