Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
angular/aio/tools/transforms
History
Alan Agius 2dc31576ab ci: add Angular CLI help pages action (#48577) 
This commits adds an action to update the Angular CLI help contents that are used by AIO to generate CLI guides.

This also changes the setup to include the files are source files instead of having to clone the repository each time. This also simplifies the PR review process of the PR opened by the action.

PR Close #48577
2023-01-10 08:01:38 -08:00
..
angular-api-package build(bazel): fix a regression where github links were incorrectly 2022-11-22 13:51:16 -07:00
angular-base-package build(bazel): prevent remote cache misses on dgeni build (#48585) 2022-12-24 11:25:40 +00:00
angular-content-package ci: add Angular CLI help pages action (#48577) 2023-01-10 08:01:38 -08:00
angular-errors-package build(bazel): use git toolchain for dgeni build 2022-11-22 13:51:16 -07:00
angular-extended-diagnostics-package build(bazel): use git toolchain for dgeni build 2022-11-22 13:51:16 -07:00
angular.io-package build(bazel): use workspace status command for AIO version stamping 2022-11-22 13:51:16 -07:00
authors-package refactor: convert AIO tooling scripts used in Bazel to ESM (#48521) 2022-12-19 19:50:44 +00:00
cli-docs-package ci: add Angular CLI help pages action (#48577) 2023-01-10 08:01:38 -08:00
content-package build(bazel): create targets for aio docs tests 2022-11-22 13:51:16 -07:00
examples-package build(bazel): add aio targets to ci 2022-11-22 13:51:16 -07:00
helpers build(bazel): add aio targets to ci 2022-11-22 13:51:16 -07:00
links-package build(bazel): create targets for aio docs tests 2022-11-22 13:51:16 -07:00
remark-package build(bazel): create targets for aio docs tests 2022-11-22 13:51:16 -07:00
target-package build(bazel): create targets for aio docs tests 2022-11-22 13:51:16 -07:00
templates ci: add Angular CLI help pages action (#48577) 2023-01-10 08:01:38 -08:00
.eslintignore build(aio): move the transforms folder into the tools folder 2017-04-16 22:05:23 +01:00
.eslintrc.js refactor(docs-infra): introduce max-len 120 eslint rule (#43439) 2021-09-15 10:47:35 -07:00
BUILD.bazel build(bazel): create targets for aio docs tests 2022-11-22 13:51:16 -07:00
config.js build(bazel): fix regressions for docs-watch 2022-11-22 13:51:16 -07:00
README.md docs(docs-infra): fix minor typos in angular.io (#47295) (#47295) 2022-09-07 10:47:21 -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 stored in the tools/transforms/templates folder. See the README.