History

Kristiyan Kostadinov e7cf1e0580 feat(docs-infra): add the ability to expose globals (#34237 ) Adds the ability to expose global symbols in the API docs via the `@globalApi` tag. Also supports optionally setting a namespace which will be added to the name automatically (e.g. `foo` will be renamed to `ng.foo`). Relevant APIs should also be exported through the `global.ts` file which will show up under `core/global`. PR Close #34237		2019-12-06 10:58:09 -08:00
..
angular-api-package	feat(docs-infra): add the ability to expose globals (#34237 )	2019-12-06 10:58:09 -08:00
angular-base-package	fix(docs-infra): do not auto-link code in bash and json snippets (#33877 )	2019-11-18 09:11:01 -08:00
angular-content-package	docs: move old quick start content into new local setup guide (#29651 )	2019-05-20 10:16:23 -07:00
angular.io-package	feat(docs-infra): generate Angular CLI command reference (#25363 )	2018-09-26 11:24:02 -07:00
authors-package	feat(upgrade): provide unit test helpers for wiring up injectors (#16848 )	2019-06-20 17:04:01 -07:00
cli-docs-package	build(docs-infra): fail hard if the CLI source is not what we expect (#30901 )	2019-06-07 08:45:47 -07:00
content-package	build(docs-infra): display github links in CLI API docs (#26515 )	2018-10-19 11:12:54 -07:00
examples-package	test(docs-infra): run tests in random order (and make them pass) (#31527 )	2019-07-18 10:17:13 -07:00
helpers	build(aio): ensure the correct decorator properties are merged (#24289 )	2018-06-06 10:23:47 -07:00
links-package	build(aio): remove unused `@linkDocs` alias for `@link` jsdoc tag (#24000 )	2018-06-13 16:47:40 -07: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	feat(docs-infra): add the ability to expose globals (#34237 )	2019-12-06 10:58:09 -08:00
.eslintignore	…
.eslintrc.js	…
README.md	…
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.