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 5b96fb9320 build(aio): rename `src/content` to `src/generated` 
This commit will definitely require a clean up of your
working folder:

```
cd aio
git clean -xdf
yarn setup
```
 		2017-05-03 13:40:46 -07:00
..
angular-api-package build(aio): add the api folder to the list of template folders 2017-05-03 13:30:11 -07:00
angular-base-package build(aio): auto-fill width/height to all image tags 2017-05-01 15:52:51 -07:00
angular-content-package build(aio): move copyContentAssets processor to the base package 2017-05-01 15:52:51 -07:00
angular.io-package feat(aio): revise Docs page; docs version selector in sidenav 2017-04-28 09:40:39 +01:00
authors-package build(aio): rename `src/content` to `src/generated` 2017-05-03 13:40:46 -07: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 build(aio): move attribute utils to helpers folder 2017-05-01 15:52:51 -07:00
links-package build(aio): move the `transforms` folder into the `tools` folder 2017-04-16 22:05:23 +01:00
post-process-package style(aio): fix comment on postProcessHtml processor 2017-05-01 15:52:51 -07:00
remark-package build(aio): convert triple backtick blocks to `code-example` tags 2017-04-30 09:07:28 -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): fix paths to template macros in overview-dump template 2017-05-03 13:30:11 -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 build(aio): rename `src/content` to `src/generated` 2017-05-03 13:40:46 -07:00
config.js build(aio): rename `src/content` to `src/generated` 2017-05-03 13:40:46 -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.