Skip to content

Commit 8b8e8ef

Browse files
committed
fix: Formatting in code groups
1 parent e848c2a commit 8b8e8ef

File tree

8 files changed

+140
-244
lines changed

8 files changed

+140
-244
lines changed

packages/documentation/docs/pages/CodeAnalysis.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,19 +88,18 @@ The **XMLComposite** control is deprecated since version UI5 1.88. Nevertheless,
8888

8989
The [XML Composite Analyzer](https://github.com/SAP/ui5-builder/blob/main/lib/lbt/analyzer/XMLCompositeAnalyzer.js) searches for the name of the configured fragment containing the **XMLComposite** control.
9090

91-
#### Name of the XMLComposite is equal to fragment name
9291

93-
```js
92+
:::code-group
93+
94+
```js [Name of the XMLComposite is equal to fragment name]
9495
sap.ui.define([
9596
"sap/ui/core/XMLComposite"
9697
], function(XMLComposite) {
9798
return XMLComposite.extend("composites.MyComposite", {}
9899
});
99100
```
100101
101-
#### Dedicated fragment name
102-
103-
```js
102+
```js [Dedicated fragment name]
104103
sap.ui.define([
105104
"sap/ui/core/XMLComposite"
106105
], function(XMLComposite) {
@@ -109,6 +108,7 @@ sap.ui.define([
109108
}
110109
});
111110
```
111+
:::
112112
113113
## Library Initialization
114114

packages/documentation/docs/pages/Configuration.md

Lines changed: 44 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -33,32 +33,24 @@ In addition, a project must define a `type`. This can be either `application`, `
3333

3434
The type defines the default path mappings and build tasks. See [UI5 Builder: Types](./Builder.md#types) for details.
3535

36-
::: details Example
37-
38-
#### application
36+
:::code-group Example
3937

40-
```yaml
38+
```yaml [application]
4139
specVersion: "4.0"
4240
type: application
4341
```
4442

45-
#### library
46-
47-
```yaml
43+
```yaml [library]
4844
specVersion: "4.0"
4945
type: library
5046
```
5147

52-
#### theme-library
53-
54-
```yaml
48+
```yaml [theme-library]
5549
specVersion: "4.0"
5650
type: theme-library
5751
```
5852

59-
#### module
60-
61-
```yaml
53+
```yaml [module]
6254
specVersion: "4.0"
6355
type: module
6456
```
@@ -124,7 +116,7 @@ Note that all configured paths must be written in POSIX (i.e. using only forward
124116
#### Available Path Mappings
125117

126118
#### Applications
127-
- `webapp`: Mapped to runtime path `/` (root)
119+
- `webapp`: Mapped to runtime path `/` (root)
128120

129121
```yaml title="Default Configuration"
130122
resources:
@@ -134,8 +126,8 @@ resources:
134126
```
135127

136128
#### Libraries
137-
- `src`: Mapped to runtime path `/resources`
138-
- `test`: Mapped to runtime path `/test-resources`
129+
- `src`: Mapped to runtime path `/resources`
130+
- `test`: Mapped to runtime path `/test-resources`
139131

140132
```yaml title="Default Configuration"
141133
resources:
@@ -184,18 +176,15 @@ resources:
184176
::: info Info
185177
This configuration is available since UI5 CLI [`v1.7.0`](https://github.com/SAP/ui5-cli/releases/tag/v1.7.0)
186178

187-
::: details Example
188-
#### UTF-8
179+
::: code-group Example
189180

190-
```yaml
181+
```yaml [UTF-8]
191182
resources:
192183
configuration:
193184
propertiesFileSourceEncoding: UTF-8
194185
```
195186

196-
#### ISO-8859-1
197-
198-
```yaml
187+
```yaml [ISO-8859-1]
199188
resources:
200189
configuration:
201190
propertiesFileSourceEncoding: ISO-8859-1
@@ -253,19 +242,20 @@ Define your project's framework dependencies.
253242

254243
In your project's framework configuration you must define whether you want to use the OpenUI5 or the SAPUI5 framework and which version:
255244

256-
#### OpenUI5
257-
```yaml
245+
::: code-group
246+
247+
```yaml [OpenUI5]
258248
framework:
259249
name: OpenUI5
260250
version: 1.82.0
261251
```
262252

263-
#### SAPUI5
264-
```yaml
253+
```yaml [SAPUI5]
265254
framework:
266255
name: SAPUI5
267256
version: 1.82.0
268257
```
258+
:::
269259

270260
If you are not sure which framework is right for you, see our [documentation on the differences between OpenUI5 and SAPUI5](./FAQ.md#whats-the-difference-between-openui5-and-sapui5).
271261

@@ -283,9 +273,9 @@ Projects that use the OpenUI5 framework cannot depend on projects that use the S
283273

284274
### Dependencies
285275

286-
::: details Example
287-
#### application
288-
```yaml
276+
::: code-group Example
277+
278+
```yaml [application]
289279
specVersion: "4.0"
290280
type: application
291281
metadata:
@@ -300,8 +290,7 @@ framework:
300290
- name: themelib_sap_fiori_3
301291
```
302292

303-
#### library
304-
```yaml
293+
```yaml [library]
305294
specVersion: "4.0"
306295
type: library
307296
metadata:
@@ -328,8 +317,9 @@ framework:
328317

329318
All libraries required by your project must be listed in the `libraries` section of the framework configuration:
330319

331-
#### OpenUI5
332-
```yaml
320+
::: code-group
321+
322+
```yaml [OpenUI5]
333323
framework:
334324
name: OpenUI5
335325
version: 1.82.0
@@ -339,8 +329,7 @@ framework:
339329
- name: sap.ui.table
340330
```
341331

342-
#### SAPUI5
343-
```yaml
332+
```yaml [SAPUI5]
344333
framework:
345334
name: SAPUI5
346335
version: 1.82.0
@@ -349,6 +338,7 @@ framework:
349338
- name: sap.m
350339
- name: sap.ui.comp
351340
```
341+
:::
352342

353343
#### Development Dependencies
354344
Development dependencies are only installed if the project defining them is the current root project.
@@ -375,10 +365,9 @@ You can choose which theme library to use by the application that is consuming t
375365
## Build Configuration
376366
### Exclude Resources
377367

378-
::: details Example
368+
::: code-group Example
379369

380-
#### application
381-
```yaml
370+
```yaml [application]
382371
builder:
383372
resources:
384373
excludes:
@@ -388,8 +377,7 @@ builder:
388377
- "/resources/my/project/namespace/test/**"
389378
```
390379

391-
#### library or theme-library
392-
```yaml
380+
```yaml [library or theme-library]
393381
builder:
394382
resources:
395383
excludes:
@@ -399,15 +387,7 @@ builder:
399387
- "!/test-resources/some/project/name/demo-app/**"
400388
- "**/*.svg"
401389
```
402-
403-
#### module
404-
405-
::: info
406-
407-
For projects of type `module`, this configuration is available since UI5 CLI [`v3.5.0`](https://github.com/SAP/ui5-cli/releases/tag/v3.5.0)
408-
and applies only to projects defining [Specification Version](#specification-versions) 3.1 or higher.
409-
410-
```yaml
390+
```yaml [module]
411391
builder:
412392
resources:
413393
excludes:
@@ -418,21 +398,28 @@ builder:
418398
```
419399
:::
420400

401+
::: info
402+
403+
For projects of type `module`, this configuration is available since UI5 CLI [`v3.5.0`](https://github.com/SAP/ui5-cli/releases/tag/v3.5.0)
404+
and applies only to projects defining [Specification Version](#specification-versions) 3.1 or higher.
405+
406+
:::
407+
421408
You can exclude a projects resources from the build process using a list of glob patterns. Matching resources will be ignored by the builder and all build tasks.
422409

423410
Patterns are applied to the **virtual resource paths** (i.e. the UI5 runtime paths). Exclude patterns are always applied after any includes.
424411

425412
### Cachebuster
426413

427-
::: details Example
428-
#### time (default)
429-
```yaml
414+
::: code-group Example
415+
416+
```yaml [time (default)]
430417
builder:
431418
cachebuster:
432419
signatureType: time
433420
```
434-
#### hash
435-
```yaml
421+
422+
```yaml [hash]
436423
builder:
437424
cachebuster:
438425
signatureType: hash
@@ -489,19 +476,17 @@ This configuration is available since UI5 CLI [`v2.10.0`](https://github.com/SAP
489476
and applies only to projects defining [Specification Version](#specification-versions)
490477
2.3 or higher.
491478

492-
::: details Example
493-
#### Single Component
479+
::: code-group Example
494480

495-
```yaml
481+
```yaml [Single Component]
496482
builder:
497483
componentPreload:
498484
excludes:
499485
- "my/awesome/app/localService/**"
500486
```
501487

502-
#### Multiple Components
503488

504-
```yaml
489+
```yaml [Multiple Components]
505490
builder:
506491
componentPreload:
507492
namespaces:

0 commit comments

Comments
 (0)