docs: add background to code-path-diagrams for dark-mode (#16822)

Tanujkanti4441 · web-flow · commit 333c71243537 · 2023-01-26T19:31:34.000+01:00
* docs: add background to code path diagrams

* docs: aligns code-path-diagrams to center

* docs: add background to architecture image

* fix: indentation checks
diff --git a/docs/.eleventy.js b/docs/.eleventy.js
@@ -195,6 +195,7 @@ module.exports = function(eleventyConfig) {
         .use(markdownItAnchor, {
             slugify
         })
+        .use(markdownItContainer, "img-container", {})
         .use(markdownItContainer, "correct", {})
         .use(markdownItContainer, "incorrect", {})
         .use(markdownItContainer, "warning", {
diff --git a/docs/src/assets/scss/docs.scss b/docs/src/assets/scss/docs.scss
@@ -126,6 +126,15 @@ div.incorrect {
     }
 }
 
+div.img-container {
+    background-color: var(--img-background-color);
+    border-radius: var(--border-radius);
+
+    img {
+        margin: 0 auto;
+    }
+}
+
 pre[class*="language-"] {
     position: relative;
 }
diff --git a/docs/src/assets/scss/tokens/themes.scss b/docs/src/assets/scss/tokens/themes.scss
@@ -131,6 +131,7 @@ html[data-theme="light"] {
     --hero-background-color: var(--color-neutral-25);
     --footer-background-color: var(--color-neutral-25);
     --outline-color: var(--color-brand);
+    --img-background-color: #fff;
 }
 
 html[data-theme="dark"] {
@@ -151,4 +152,5 @@ html[data-theme="dark"] {
     --hero-background-color: var(--color-neutral-800);
     --footer-background-color: var(--color-neutral-800);
     --outline-color: #fff;
+    --img-background-color: var(--color-neutral-300);
 }
diff --git a/docs/src/contribute/architecture/index.md b/docs/src/contribute/architecture/index.md
@@ -7,7 +7,9 @@ eleventyNavigation:
     order: 1
 ---
 
-<center><img alt="dependency graph" src="../../assets/images/architecture/dependency.svg"></center>
+:::img-container
+<img alt="dependency graph" src="../../assets/images/architecture/dependency.svg">
+:::
 
 At a high level, there are a few key parts to ESLint:
 
diff --git a/docs/src/extend/code-path-analysis.md b/docs/src/extend/code-path-analysis.md
@@ -14,7 +14,9 @@ if (a && b) {
 bar();
 ```
 
+:::img-container
 ![Code Path Example](../assets/images/code-path-analysis/helo.svg)
+:::
 
 ## Objects
 
@@ -143,17 +145,23 @@ bar();
 
 1. First, the analysis advances to the end of loop.
 
+:::img-container
    ![Loop Event's Example 1](../assets/images/code-path-analysis/loop-event-example-while-1.svg)
+:::
 
 2. Second, it creates the looping path.
    At this time, the next segment has existed already, so the `onCodePathSegmentStart` event is not fired.
    It fires `onCodePathSegmentLoop` instead.
 
+:::img-container
    ![Loop Event's Example 2](../assets/images/code-path-analysis/loop-event-example-while-2.svg)
+:::
 
 3. Last, it advances to the end.
 
+:::img-container
    ![Loop Event's Example 3](../assets/images/code-path-analysis/loop-event-example-while-3.svg)
+:::
 
 For example 2:
 
@@ -168,29 +176,39 @@ bar();
    First, the analysis advances to `ForStatement.update`.
    The `update` segment is hovered at first.
 
+:::img-container
    ![Loop Event's Example 1](../assets/images/code-path-analysis/loop-event-example-for-1.svg)
+:::
 
 2. Second, it advances to `ForStatement.body`.
    Of course the `body` segment is preceded by the `test` segment.
    It keeps the `update` segment hovering.
 
+:::img-container
    ![Loop Event's Example 2](../assets/images/code-path-analysis/loop-event-example-for-2.svg)
+:::
 
 3. Third, it creates the looping path from `body` segment to `update` segment.
    At this time, the next segment has existed already, so the `onCodePathSegmentStart` event is not fired.
    It fires `onCodePathSegmentLoop` instead.
 
+:::img-container
    ![Loop Event's Example 3](../assets/images/code-path-analysis/loop-event-example-for-3.svg)
+:::
 
 4. Fourth, also it creates the looping path from `update` segment to `test` segment.
    At this time, the next segment has existed already, so the `onCodePathSegmentStart` event is not fired.
    It fires `onCodePathSegmentLoop` instead.
 
+:::img-container
    ![Loop Event's Example 4](../assets/images/code-path-analysis/loop-event-example-for-4.svg)
+:::
 
 5. Last, it advances to the end.
 
+:::img-container
    ![Loop Event's Example 5](../assets/images/code-path-analysis/loop-event-example-for-5.svg)
+:::
 
 ## Usage Examples
 
@@ -336,7 +354,9 @@ See Also:
 console.log("Hello world!");
 ```
 
+:::img-container
 ![Hello World](../assets/images/code-path-analysis/example-hello-world.svg)
+:::
 
 ### `IfStatement`
 
@@ -348,7 +368,9 @@ if (a) {
 }
 ```
 
+:::img-container
 ![`IfStatement`](../assets/images/code-path-analysis/example-ifstatement.svg)
+:::
 
 ### `IfStatement` (chain)
 
@@ -362,7 +384,9 @@ if (a) {
 }
 ```
 
+:::img-container
 ![`IfStatement` (chain)](../assets/images/code-path-analysis/example-ifstatement-chain.svg)
+:::
 
 ### `SwitchStatement`
 
@@ -383,7 +407,9 @@ switch (a) {
 }
 ```
 
+:::img-container
 ![`SwitchStatement`](../assets/images/code-path-analysis/example-switchstatement.svg)
+:::
 
 ### `SwitchStatement` (has `default`)
 
@@ -408,7 +434,9 @@ switch (a) {
 }
 ```
 
+:::img-container
 ![`SwitchStatement` (has `default`)](../assets/images/code-path-analysis/example-switchstatement-has-default.svg)
+:::
 
 ### `TryStatement` (try-catch)
 
@@ -431,7 +459,9 @@ It creates the paths from `try` block to `catch` block at:
 * The first throwable node (e.g. a function call) in the `try` block.
 * The end of the `try` block.
 
+:::img-container
 ![`TryStatement` (try-catch)](../assets/images/code-path-analysis/example-trystatement-try-catch.svg)
+:::
 
 ### `TryStatement` (try-finally)
 
@@ -449,7 +479,9 @@ If there is not `catch` block, `finally` block has two current segments.
 At this time, `CodePath.currentSegments.length` is `2`.
 One is the normal path, and another is the leaving path (`throw` or `return`).
 
+:::img-container
 ![`TryStatement` (try-finally)](../assets/images/code-path-analysis/example-trystatement-try-finally.svg)
+:::
 
 ### `TryStatement` (try-catch-finally)
 
@@ -465,7 +497,9 @@ try {
 last();
 ```
 
+:::img-container
 ![`TryStatement` (try-catch-finally)](../assets/images/code-path-analysis/example-trystatement-try-catch-finally.svg)
+:::
 
 ### `WhileStatement`
 
@@ -479,7 +513,9 @@ while (a) {
 }
 ```
 
+:::img-container
 ![`WhileStatement`](../assets/images/code-path-analysis/example-whilestatement.svg)
+:::
 
 ### `DoWhileStatement`
 
@@ -490,7 +526,9 @@ do {
 } while (a);
 ```
 
+:::img-container
 ![`DoWhileStatement`](../assets/images/code-path-analysis/example-dowhilestatement.svg)
+:::
 
 ### `ForStatement`
 
@@ -504,7 +542,9 @@ for (let i = 0; i < 10; ++i) {
 }
 ```
 
+:::img-container
 ![`ForStatement`](../assets/images/code-path-analysis/example-forstatement.svg)
+:::
 
 ### `ForStatement` (for ever)
 
@@ -515,7 +555,9 @@ for (;;) {
 bar();
 ```
 
+:::img-container
 ![`ForStatement` (for ever)](../assets/images/code-path-analysis/example-forstatement-for-ever.svg)
+:::
 
 ### `ForInStatement`
 
@@ -525,7 +567,9 @@ for (let key in obj) {
 }
 ```
 
+:::img-container
 ![`ForInStatement`](../assets/images/code-path-analysis/example-forinstatement.svg)
+:::
 
 ### When there is a function
 
@@ -544,8 +588,12 @@ It creates two code paths.
 
 * The global's
 
+:::img-container
   ![When there is a function](../assets/images/code-path-analysis/example-when-there-is-a-function-g.svg)
+:::
 
 * The function's
 
+:::img-container
   ![When there is a function](../assets/images/code-path-analysis/example-when-there-is-a-function-f.svg)
+:::

Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,15 @@ div.incorrect {`
`126`	`126`	`}`
`127`	`127`	`}`
`128`	`128`
	`129`	`+div.img-container {`
	`130`	`+ background-color: var(--img-background-color);`
	`131`	`+ border-radius: var(--border-radius);`
	`132`	`+`
	`133`	`+ img {`
	`134`	`+ margin: 0 auto;`
	`135`	`+ }`
	`136`	`+}`
	`137`	`+`
`129`	`138`	`pre[class*="language-"] {`
`130`	`139`	`position: relative;`
`131`	`140`	`}`
Original file line number	Diff line number	Diff line change
`@@ -131,6 +131,7 @@ html[data-theme="light"] {`
`131`	`131`	`--hero-background-color: var(--color-neutral-25);`
`132`	`132`	`--footer-background-color: var(--color-neutral-25);`
`133`	`133`	`--outline-color: var(--color-brand);`
	`134`	`+ --img-background-color: #fff;`
`134`	`135`	`}`
`135`	`136`
`136`	`137`	`html[data-theme="dark"] {`
`@@ -151,4 +152,5 @@ html[data-theme="dark"] {`
`151`	`152`	`--hero-background-color: var(--color-neutral-800);`
`152`	`153`	`--footer-background-color: var(--color-neutral-800);`
`153`	`154`	`--outline-color: #fff;`
	`155`	`+ --img-background-color: var(--color-neutral-300);`
`154`	`156`	`}`