History

Peter Bacon Darwin e8bbf86e66 build(aio): add terms from heading to the search index		2017-07-11 15:04:37 +01:00
..
angular-api-package	build(aio): fix matchUpDirectiveDecorators processor	2017-07-11 11:44:05 +01:00
angular-base-package	build(aio): add terms from heading to the search index	2017-07-11 15:04:37 +01:00
angular-content-package	build(aio): do not recurse node_modules when loading examples in doc-gen	2017-06-21 13:51:15 -07:00
angular.io-package	build(aio): fail the doc-gen if there is an invalid `{@link ...}` tag	2017-05-10 11:39:07 +01:00
authors-package	build(aio): increase docs integration test timeouts	2017-06-13 11:56:45 +01:00
content-package	build(aio): refactor dgeni packages	2017-04-23 22:50:33 +01:00
examples-package	build(aio): move attribute utils to helpers folder	2017-05-01 15:52:51 -07:00
helpers	test(aio): add tests for renderAttributes helper	2017-05-11 10:30:10 +01:00
links-package	build(aio): better error message for invalid links (#16993 )	2017-05-24 11:59:06 -06:00
post-process-package	build(aio): capture the h1 title and attach it to the document	2017-05-31 08:45:31 +03:00
remark-package	build(aio): throw an error if a code-example tag is not closed	2017-05-04 15:52:17 -07:00
target-package	build(aio): move the `transforms` folder into the `tools` folder	2017-04-16 22:05:23 +01:00
templates	build(aio): use dedicated overview for decorator API docs	2017-07-11 11:44:05 +01:00
.eslintignore	build(aio): move the `transforms` folder into the `tools` folder	2017-04-16 22:05:23 +01:00
.eslintrc.js	build(aio): move the `transforms` folder into the `tools` folder	2017-04-16 22:05:23 +01:00
README.md	build(aio): rename `src/content` to `src/generated`	2017-05-03 13:40:46 -07:00
config.js	build(aio): ignore example files that are gitignored	2017-06-09 14:33:21 +01:00
test.js	build(aio): ensure all doc tests are run	2017-06-21 13:51:15 -07:00

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 tools/transforms/angular.io-package/index.js. This 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.

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/generated 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.