angular-cn/aio/transforms/README.md

# Documentation Generation

The dgeni tool is used to generate the documentation from the source files held in this repository.
The documentation generation is configured by a dgeni package defined in `docs/angular.io-package/index.js`.
This package, in turn requires a number of other packages, some are defined locally in the `docs` folder,
such as `docs/cheatsheet-package` and `docs/content-package`, etc. And some are brought in from the
`dgeni-packages` node modules, such as `jsdoc` and `nunjucks`.

## Generating the docs

To generate the documentation simply run `yarn docs` from the command line.

## Testing the dgeni packages

The local packages have unit tests that you can execute by running `yarn docs-test` from the command line.

## What does it generate?

The output from dgeni is written to files in the `src/content` folder.

Notably this includes a JSON file containing the partial HTML for each "page" of the documentation, such as API pages and guides.
It also includes JSON files that contain metadata about the documentation such as navigation data and
keywords for building a search index.

## Viewing the docs

You can view the pages by running `yarn start` and navigating to https://localhost:4200.
build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 09:03:53 -05:00			`# Documentation Generation`

			`The dgeni tool is used to generate the documentation from the source files held in this repository.`
			The documentation generation is configured by a dgeni package defined in `docs/angular.io-package/index.js`.
			This package, in turn requires a number of other packages, some are defined locally in the `docs` folder,
			such as `docs/cheatsheet-package` and `docs/content-package`, etc. And some are brought in from the
			`dgeni-packages` node modules, such as `jsdoc` and `nunjucks`.

			`## Generating the docs`

build(aio): add `doc-watch` yarn task for docs authors This task is suitable for day to day docs authoring. This task cuts corners, which makes it much faster than a full `yarn docs` run but it does not produce completely valid output. In general this isgood enough for authors to see their changes as they make them. The task is triggered by a call to ``` yarn docs-watch ``` This sets up watchers on the `aio/contents` and `packages` folders. Any changes to files below these folders new doc generation run to start. The input to the generation is confined to a collection of files related to the changed file. For example: * a change to a file in `aio/content/marketing` will generate all the marketing files. * a change to a file in `aio/content/tutorial` or `aio/examples/toh-` will generate all the tutorial files (and their embedded examples). a change to a file in `aio/guide` or `aio/examples` (but not a `toh-` example) will generate the appropriate guide and its embedded examples * a change to a file in `packages` or `packages/examples` will generate the appropriate API doc and its embedded examples. Be aware that the mapping between docs and its examples are based on doc file and example folder structure being equivalent. Sometimes a doc will reference an example in a different folder, in which case the generated doc will be inaccurate. Mostly this is not a big problem. 2017-04-16 15:48:22 -04:00			To generate the documentation simply run `yarn docs` from the command line.
build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 09:03:53 -05:00
			`## Testing the dgeni packages`

build(aio): add `doc-watch` yarn task for docs authors This task is suitable for day to day docs authoring. This task cuts corners, which makes it much faster than a full `yarn docs` run but it does not produce completely valid output. In general this isgood enough for authors to see their changes as they make them. The task is triggered by a call to ``` yarn docs-watch ``` This sets up watchers on the `aio/contents` and `packages` folders. Any changes to files below these folders new doc generation run to start. The input to the generation is confined to a collection of files related to the changed file. For example: * a change to a file in `aio/content/marketing` will generate all the marketing files. * a change to a file in `aio/content/tutorial` or `aio/examples/toh-` will generate all the tutorial files (and their embedded examples). a change to a file in `aio/guide` or `aio/examples` (but not a `toh-` example) will generate the appropriate guide and its embedded examples * a change to a file in `packages` or `packages/examples` will generate the appropriate API doc and its embedded examples. Be aware that the mapping between docs and its examples are based on doc file and example folder structure being equivalent. Sometimes a doc will reference an example in a different folder, in which case the generated doc will be inaccurate. Mostly this is not a big problem. 2017-04-16 15:48:22 -04:00			The local packages have unit tests that you can execute by running `yarn docs-test` from the command line.
build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 09:03:53 -05:00
			`## What does it generate?`

build(aio): add `doc-watch` yarn task for docs authors This task is suitable for day to day docs authoring. This task cuts corners, which makes it much faster than a full `yarn docs` run but it does not produce completely valid output. In general this isgood enough for authors to see their changes as they make them. The task is triggered by a call to ``` yarn docs-watch ``` This sets up watchers on the `aio/contents` and `packages` folders. Any changes to files below these folders new doc generation run to start. The input to the generation is confined to a collection of files related to the changed file. For example: * a change to a file in `aio/content/marketing` will generate all the marketing files. * a change to a file in `aio/content/tutorial` or `aio/examples/toh-` will generate all the tutorial files (and their embedded examples). a change to a file in `aio/guide` or `aio/examples` (but not a `toh-` example) will generate the appropriate guide and its embedded examples * a change to a file in `packages` or `packages/examples` will generate the appropriate API doc and its embedded examples. Be aware that the mapping between docs and its examples are based on doc file and example folder structure being equivalent. Sometimes a doc will reference an example in a different folder, in which case the generated doc will be inaccurate. Mostly this is not a big problem. 2017-04-16 15:48:22 -04:00			The output from dgeni is written to files in the `src/content` folder.
build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 09:03:53 -05:00
build(aio): add `doc-watch` yarn task for docs authors This task is suitable for day to day docs authoring. This task cuts corners, which makes it much faster than a full `yarn docs` run but it does not produce completely valid output. In general this isgood enough for authors to see their changes as they make them. The task is triggered by a call to ``` yarn docs-watch ``` This sets up watchers on the `aio/contents` and `packages` folders. Any changes to files below these folders new doc generation run to start. The input to the generation is confined to a collection of files related to the changed file. For example: * a change to a file in `aio/content/marketing` will generate all the marketing files. * a change to a file in `aio/content/tutorial` or `aio/examples/toh-` will generate all the tutorial files (and their embedded examples). a change to a file in `aio/guide` or `aio/examples` (but not a `toh-` example) will generate the appropriate guide and its embedded examples * a change to a file in `packages` or `packages/examples` will generate the appropriate API doc and its embedded examples. Be aware that the mapping between docs and its examples are based on doc file and example folder structure being equivalent. Sometimes a doc will reference an example in a different folder, in which case the generated doc will be inaccurate. Mostly this is not a big problem. 2017-04-16 15:48:22 -04:00			`Notably this includes a JSON file containing the partial HTML for each "page" of the documentation, such as API pages and guides.`
			`It also includes JSON files that contain metadata about the documentation such as navigation data and`
build(aio): move doc-gen stuff from angular.io (#14097) 2017-01-26 09:03:53 -05:00			`keywords for building a search index.`

			`## Viewing the docs`

build(aio): add `doc-watch` yarn task for docs authors This task is suitable for day to day docs authoring. This task cuts corners, which makes it much faster than a full `yarn docs` run but it does not produce completely valid output. In general this isgood enough for authors to see their changes as they make them. The task is triggered by a call to ``` yarn docs-watch ``` This sets up watchers on the `aio/contents` and `packages` folders. Any changes to files below these folders new doc generation run to start. The input to the generation is confined to a collection of files related to the changed file. For example: * a change to a file in `aio/content/marketing` will generate all the marketing files. * a change to a file in `aio/content/tutorial` or `aio/examples/toh-` will generate all the tutorial files (and their embedded examples). a change to a file in `aio/guide` or `aio/examples` (but not a `toh-` example) will generate the appropriate guide and its embedded examples * a change to a file in `packages` or `packages/examples` will generate the appropriate API doc and its embedded examples. Be aware that the mapping between docs and its examples are based on doc file and example folder structure being equivalent. Sometimes a doc will reference an example in a different folder, in which case the generated doc will be inaccurate. Mostly this is not a big problem. 2017-04-16 15:48:22 -04:00			You can view the pages by running `yarn start` and navigating to https://localhost:4200.