honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-cn/aio/tools/transforms
History
Peter Bacon Darwin 4530654501 docs(aio): high-level documentation of the `transforms` folder (#18151) 
PR Close #18151
 		2017-09-21 10:00:36 -07:00
..
angular-api-package build(aio): auto-link more code items 2017-09-12 13:58:43 -04:00
angular-base-package build(aio): auto-link more code items 2017-09-12 13:58:43 -04:00
angular-content-package build(aio): improve error message for ignored example files (#19265) 2017-09-20 12:36:14 -07:00
angular.io-package build(aio): abort doc-gen on dangling links 2017-07-18 11:45:05 +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): improve error message for ignored example files (#19265) 2017-09-20 12:36:14 -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 docs(aio): high-level documentation of the `transforms` folder (#18151) 2017-09-21 10:00:36 -07: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 docs(aio): high-level documentation of the `transforms` folder (#18151) 2017-09-21 10:00:36 -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

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 the aio/tools/transforms folder. See the README.md for more details.

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