cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
angular/aio/tools/transforms
History
Pete Bacon Darwin 27962f8949 build(aio): improve accuracy of code auto-linking (#22494) 
The new version of `dgeni-packages/typescript` no longer strips
out "namespaces" from types, which was part of the problem of
not autolinking correctly to `HttpEventType.Response`.

Another part of the problem was that we did not include `.`
characters when matching potential code blocks for auto-linking,
which precluded properties of enums from being linked.

Finally, members we not being given a `path` property, which is
needed to effectively autolink to them. This is now set in
the `simplifyMemberAnchors` processor.

Closes #21375

PR Close #22494
2018-03-01 08:12:25 -08:00
..
angular-api-package
build(aio): improve accuracy of code auto-linking (#22494)
2018-03-01 08:12:25 -08:00
angular-base-package
build(aio): improve accuracy of code auto-linking (#22494)
2018-03-01 08:12:25 -08:00
angular-content-package
feat(aio): enable data driven homepage announcements (#22043)
2018-02-09 13:10:12 -08:00
angular.io-package
build(aio): move file cleaning to later in the doc gen (#21540)
2018-01-16 07:11:01 -08:00
authors-package
test(aio): increase docs-test timeouts to prevent flakes on Travis (#22261)
2018-02-16 14:46:23 -08:00
content-package
build(aio): refactor dgeni packages
2017-04-23 22:50:33 +01:00
examples-package
build(aio): initialise exampleMap correctly (#22502)
2018-03-01 08:10:15 -08:00
helpers
test(aio): add tests for renderAttributes helper
2017-05-11 10:30:10 +01:00
links-package
build(aio): move link disambiguation from getLinkInfo to getDocFromAlias (#22494)
2018-03-01 08:11:19 -08:00
post-process-package
style(aio): fix docs linting issues (#19702)
2017-11-01 15:24:46 -07: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): upgrade to dgeni-packages 0.24.0 (#21802)
2018-01-31 10:20:37 -08:00
.eslintignore
build(aio): move the transforms folder into the tools folder
2017-04-16 22:05:23 +01:00
.eslintrc.js
style(aio): fix docs linting issues (#19702)
2017-11-01 15:24:46 -07:00
config.js
build(aio): ignore example files that are gitignored
2017-06-09 14:33:21 +01:00
README.md
docs(aio): tidy up tooling documentation (#18151)
2017-09-21 10:00:37 -07: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 this folder (aio/tools/transforms).

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

All the templates for the angular.io dgeni transformations are stoted in the tools/transforms/templates folder. See the README.