angular-docs-cn/aio/transforms
Pete Bacon Darwin 600402d440 build(aio): big move of docs related files (#14361)
All the docs related files (docs-app, doc-gen, content, etc)
are now to be found inside the `/aio` folder.

The related gulp tasks have been moved from the top level
gulp file to a new one inside the `/aio` folder.

The structure of the `/aio` folder now looks like:

```
/aio/
  build/         # gulp tasks
  content/       #MARKDOWN FILES for devguides, cheatsheet, etc
    devguides/
    cheatsheets/
  transforms/    #dgeni packages, templates, etc
  src/
    app/
    assets/
    content/    #HTML + JSON build artifacts produced by dgeni from /aio/content.
                #This dir is .gitignored-ed
  e2e/           #protractor tests for the doc viewer app
  node_modules/ #dependencies for both the doc viewer builds and the dgeni stuff
                #This dir is .gitignored-ed
  gulpfile.js   #Tasks for generating docs and building & deploying the doc viewer
```

Closes #14361
2017-02-09 11:58:36 -08:00
..
angular.io-package build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
cheatsheet-package build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
content-package build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
examples-package build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
helpers build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
links-package build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
rho-package build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
target-package build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
templates build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
README.md build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08:00
eslintrc.js build(aio): big move of docs related files (#14361) 2017-02-09 11:58:36 -08: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 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 gulp docs from the command line.

Testing the dgeni packages

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

What does it generate?

The output from dgeni is written to files in the dist/docs folder.

Notably this includes a partial HTML file for each "page" of the documentation, such as API pages and guides. It also includes JavaScript 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 dummy demo app using a simple HTTP server hosting dist/docs/index.html