build: set up markdown pipeline for the reference section (#53290)

Set up the markdown pipeline to include the required source files.

PR Close #53290
This commit is contained in:
Joey Perrott
2023-11-30 19:43:48 +00:00
committed by Dylan Hunn
parent dae3e24d14
commit 40e8577faf
10 changed files with 62 additions and 5 deletions
@@ -5,3 +5,8 @@ package(default_visibility = ["//visibility:public"])
docs_example(
name = "angular-compiler-options",
)
exports_files([
"tsconfig.app.json",
"tsconfig.json",
])
@@ -0,0 +1 @@
exports_files(glob(["**/*"]))
+11
View File
@@ -0,0 +1,11 @@
load("@npm//@angular/build-tooling/bazel/markdown_to_html:markdown_to_html.bzl", "markdown_to_html")
markdown_to_html(
name = "reference",
srcs = glob([
"*.md",
]),
data = [
"//adev/src/assets/images:roadmap.svg",
],
)
@@ -0,0 +1,12 @@
load("@npm//@angular/build-tooling/bazel/markdown_to_html:markdown_to_html.bzl", "markdown_to_html")
markdown_to_html(
name = "configs",
srcs = glob([
"*.md",
]),
data = [
"//adev/src/content/examples/angular-compiler-options:tsconfig.app.json",
"//adev/src/content/examples/angular-compiler-options:tsconfig.json",
],
)
@@ -4,7 +4,7 @@ When you use [ahead-of-time compilation (AOT)](tools/cli/aot-compiler), you can
The Angular options object, `angularCompilerOptions`, is a sibling to the `compilerOptions` object that supplies standard options to the TypeScript compiler.
<docs-code header="tsconfig.json" path="angular-compiler-options/tsconfig.json" visibleRegion="angular-compiler-options"/>
<docs-code header="tsconfig.json" path="adev/src/content/examples/angular-compiler-options/tsconfig.json" visibleRegion="angular-compiler-options"/>
## Configuration inheritance with `extends`
@@ -16,7 +16,7 @@ The configuration options from the base file are loaded first, then overridden b
For example:
<docs-code header="tsconfig.app.json" path="angular-compiler-options/tsconfig.app.json" visibleRegion="angular-compiler-options-app"/>
<docs-code header="tsconfig.app.json" path="adev/src/content/examples/angular-compiler-options/tsconfig.app.json" visibleRegion="angular-compiler-options-app"/>
For more information, see the [TypeScript Handbook](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html).
@@ -0,0 +1,12 @@
load("@npm//@angular/build-tooling/bazel/markdown_to_html:markdown_to_html.bzl", "markdown_to_html")
markdown_to_html(
name = "errors",
srcs = glob([
"*.md",
]),
data = [
"//adev/src/content/examples/errors:cyclic-imports/child.component.ts",
"//adev/src/content/examples/errors:cyclic-imports/parent.component.ts",
],
)
+2 -2
View File
@@ -3,9 +3,9 @@
A component, directive, or pipe that is referenced by this component would require the compiler to add an import that would lead to a cycle of imports.
For example, consider a scenario where a `ParentComponent` references a `ChildComponent` in its template:
<docs-code header="parent.component.ts" path="errors/cyclic-imports/parent.component.ts"/>
<docs-code header="parent.component.ts" path="adev/src/content/examples/errors/cyclic-imports/parent.component.ts"/>
<docs-code header="child.component.ts" path="errors/cyclic-imports/child.component.ts"/>
<docs-code header="child.component.ts" path="adev/src/content/examples/errors/cyclic-imports/child.component.ts"/>
There is already an import from `child.component.ts` to `parent.component.ts` since the `ChildComponent` references the `ParentComponent` in its constructor.
@@ -0,0 +1,8 @@
load("@npm//@angular/build-tooling/bazel/markdown_to_html:markdown_to_html.bzl", "markdown_to_html")
markdown_to_html(
name = "extended-diagnostics",
srcs = glob([
"*.md",
]),
)
@@ -0,0 +1,8 @@
load("@npm//@angular/build-tooling/bazel/markdown_to_html:markdown_to_html.bzl", "markdown_to_html")
markdown_to_html(
name = "migrations",
srcs = glob([
"*.md",
]),
)
+1 -1
View File
@@ -1,4 +1,4 @@
<docs-decorative-header title="Angular Roadmap" imgSrc="assets/images/roadmap.svg"> <!-- markdownlint-disable-line -->
<docs-decorative-header title="Angular Roadmap" imgSrc="adev/src/assets/images/roadmap.svg"> <!-- markdownlint-disable-line -->
Learn how the Angular team is building momentum on the web.
</docs-decorative-header>