History

Pete Bacon Darwin fbdb19c263 docs(localize): expose documentation for the `@angular/localize` package (#40317 ) PR Close #40317		2021-03-19 12:36:10 -07:00
..
angular-api-package	docs(localize): expose documentation for the `@angular/localize` package (#40317 )	2021-03-19 12:36:10 -07:00
angular-base-package	build(docs-infra): move docs-watch settings to a base package (#40479 )	2021-01-20 16:12:15 -08:00
angular-content-package	build(docs-infra): move docs-watch settings to a base package (#40479 )	2021-01-20 16:12:15 -08:00
angular-errors-package	docs: add embedded videos to error guides (#40453 )	2021-01-20 08:47:00 -08:00
angular.io-package	build(docs-infra): move docs-watch settings to a base package (#40479 )	2021-01-20 16:12:15 -08:00
authors-package	feat(platform-server): allow shimming the global env sooner (#40559 )	2021-02-12 08:55:25 -08:00
cli-docs-package	fix(docs-infra): correctly generate CLI commands docs when the overview page moves (#38365 )	2020-08-06 11:41:05 -07:00
content-package	build(docs-infra): implement `@reviewed` tag definition (#40582 )	2021-01-28 09:04:49 -08:00
examples-package	build(docs-infra): fail if there are unused example regions (#40479 )	2021-01-20 16:12:15 -08:00
helpers	build: update license headers to reference Google LLC (#37205 )	2020-05-26 14:26:58 -04:00
links-package	build(docs-infra): move docs-watch settings to a base package (#40479 )	2021-01-20 16:12:15 -08:00
remark-package	refactor(docs-infra): remove `linenums=false` since it is now the default (#31674 )	2019-07-24 14:38:54 -07:00
target-package	…
templates	build(docs-infra): add a link to `usage notes` from `description` (#40835 )	2021-02-16 07:47:08 -08:00
.eslintignore	…
.eslintrc.js	…
README.md	docs(docs-infra): apply the one-sentence-per-line rule to Markdown files in `aio/tools/` (#38992 )	2020-09-30 09:20:00 -04:00
config.js	…
test.js	test(docs-infra): run tests in random order (and make them pass) (#31527 )	2019-07-18 10:17:13 -07:00

README.md

Overview

All the content that is rendered by the AIO application, and some of its configuration files, are generated from source files by Dgeni. Dgeni is a general purpose documentation generation tool.

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.

Dgeni is configured by "packages", which contain services and processors. Some of these packages are installed as node_modules from the dgeni-packages and some are specific to the AIO project.

The project specific packages are stored in this folder (aio/tools/transforms).

If you are an author and want to know how to generate the documentation, the steps are outlined in the top level README.md.

Root packages

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.

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

All the templates for the angular.io dgeni transformations are stoted in the tools/transforms/templates folder. See the README.