Skip to content

Commit 6adb078

Browse files
committed
fix: Rebase missmatches
1 parent 954f848 commit 6adb078

File tree

12 files changed

+140
-168
lines changed

12 files changed

+140
-168
lines changed
-29 KB
Binary file not shown.

packages/documentation/docs/index.md

Lines changed: 12 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@ next:
44
link: '/pages/GettingStarted'
55
---
66

7-
![UI5 logo](./images/UI5_logo_wide.png) { .light-only }
7+
<script setup>
8+
import { useData } from 'vitepress'
9+
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
10+
const { isDark } = useData()
11+
</script>
812

9-
![UI5 logo](./images/UI5_logo_wide_dark.png) { .dark-only }
13+
<img :src="isDark ? '/ui5-cli/stable/images/O_UI5_H_noBG.png' : '/ui5-cli/stable/images/UI5_logo_wide.png'" alt="UI5 logo" style="max-width: 100%; height: auto;">
1014

1115
# UI5 CLI
1216

@@ -26,34 +30,9 @@ Read the announcement blog post: **[SAP Community: UI5 CLI 4.0](https://communit
2630
And checkout the **[Migrate to v4](./updates/migrate-v4)** documentation.
2731
:::
2832

29-
<script setup>
30-
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
31-
</script>
32-
33-
<VPButton class="no-decoration" text="🚀 Get Started" href="./pages/GettingStarted"/>
34-
35-
<style>
36-
.no-decoration {
37-
text-decoration: inherit;
38-
}
39-
40-
/* Theme-based image visibility */
41-
.light-only {
42-
display: block;
43-
}
44-
45-
.dark-only {
46-
display: none;
47-
}
48-
49-
html.dark .light-only {
50-
display: none;
51-
}
52-
53-
html.dark .dark-only {
54-
display: block;
55-
}
56-
</style>
33+
<div style="margin: 2rem 0;">
34+
<VPButton class="no-decoration" text="🚀 Get Started" href="./pages/GettingStarted"/>
35+
</div>
5736

5837
## Main Features
5938

@@ -101,7 +80,7 @@ Added framework libraries sap.ui.core sap.m themelib_sap_fiori_3 as dependencies
10180
#### 🏄 Development Server
10281

10382
Start a local development server to work on your project.
104-
*Also see the [Server Documentation](./pages/Server)*
83+
*Also see the [Server Documentation](./Server)*
10584

10685
```
10786
❯ ui5 serve
@@ -140,7 +119,7 @@ All available APIs are documented in the [UI5 CLI API Reference](https://ui5.git
140119

141120
#### ESM
142121

143-
```js linenums="1
122+
```js
144123
import {graphFromPackageDependencies} from "@ui5/project/graph";
145124

146125
async function buildApp(projectPath, destinationPath) {
@@ -158,7 +137,7 @@ async function buildApp(projectPath, destinationPath) {
158137

159138
#### CommonJS
160139

161-
```js linenums="1
140+
```js
162141
async function buildApp(projectPath, destinationPath) {
163142
const {graphFromPackageDependencies} =
164143
await import("@ui5/project/graph");

packages/documentation/docs/pages/Builder.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,17 @@
22

33
The [UI5 Builder](https://github.com/SAP/ui5-builder) module takes care of building your project.
44

5-
Based on a project's type, the UI5 Builder defines a series of build steps to execute; these are also called "tasks".
6-
7-
For every type there is a set of default tasks. You can disable single tasks using the `--exclude-task` [CLI parameter](./CLI#ui5-build), and you can include tasks using the `--include-task` parameter.
8-
95
<script setup>
106
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
117
</script>
128

13-
<VPButton class="api-button" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/index.html" target="_blank"/>
9+
Based on a project's type, the UI5 Builder defines a series of build steps to execute; these are also called "tasks".
1410

15-
<style>
16-
.api-button {
17-
margin: 1rem 0;
18-
}
19-
</style>
11+
For every type there is a set of default tasks. You can disable single tasks using the `--exclude-task` [CLI parameter](./CLI#ui5-build), and you can include tasks using the `--include-task` parameter.
12+
13+
<div style="margin: 1rem 0;">
14+
<VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/index.html"/>
15+
</div>
2016

2117
## Tasks
2218
Tasks are specific build steps to be executed during build phase.
@@ -197,4 +193,9 @@ sap.ui.define([], () => {
197193
});
198194
```
199195

200-
:::
196+
:::
197+
<style>
198+
.no-decoration {
199+
text-decoration: inherit;
200+
}
201+
</style>

packages/documentation/docs/pages/FileSystem.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,9 @@ The [UI5 FS](https://github.com/SAP/ui5-fs) provides a UI5-specific file system
66
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
77
</script>
88

9-
<VPButton class="api-button" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/" target="_blank"/>
10-
11-
<style>
12-
.api-button {
13-
margin: 1rem 0;
14-
}
15-
</style>
9+
<div style="margin: 1rem 0;">
10+
<VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/"/>
11+
</div>
1612

1713
## Overview
1814

@@ -51,3 +47,9 @@ They implement the same API for **retrieving** resources as adapters (`byPath` a
5147
* [ReaderCollectionPrioritized](https://ui5.github.io/cli/v4/api/@ui5_fs_ReaderCollectionPrioritized.html): Contains a list of readers which are searched in-order. This allows one reader to "overlay" resources of another
5248
* [DuplexCollection](https://ui5.github.io/cli/v4/api/@ui5_fs_DuplexCollection.html): Contains a single reader and a single "writer". It therefore also implements the Adapter API for **persisting** resources (`write()`). When retrieving resources, the writer is prioritized over the reader
5349
* [WriterCollection](https://ui5.github.io/cli/v4/api/@ui5_fs_WriterCollection.html): Contains a set of writers and a mapping for each of them. When writing a resource, the writer is chosen based on the resource's virtual path.
50+
51+
<style>
52+
.no-decoration {
53+
text-decoration: inherit;
54+
}
55+
</style>

packages/documentation/docs/pages/GettingStarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ ui5 use sapui5@latest
6565
:::
6666
You can choose between the OpenUI5 and the SAPUI5 framework.
6767

68-
Don't know which one to choose? Check out our [documentation on the differences between OpenUI5 and SAPUI5](./FAQ##whats-the-difference-between-openui5-and-sapui5).
68+
Don't know which one to choose? Check out our [documentation on the differences between OpenUI5 and SAPUI5](./FAQ#what-s-the-difference-between-openui5-and-sapui5).
6969

7070
1. Add required libraries
7171
```sh

packages/documentation/docs/pages/Project.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
The [UI5 Project](https://github.com/SAP/ui5-project) module provides functionality to build a UI5 project. Also see [Development Overview: Project Dependencies](./Overview#project-dependencies).
44

5+
<script setup>
6+
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
7+
</script>
8+
59
## Types
610
Types define how a project can be configured and how it is built. A type orchestrates a set of tasks and defines the order in which they get applied during build phase. Furthermore, it takes care of formatting and validating the project-specific configuration.
711

@@ -63,14 +67,13 @@ In the table below you can find the available combinations of project type & out
6367
^2^ Theme libraries in most cases have more than one namespace.
6468
^3^ Modules have explicit path mappings configured and no namespace concept.
6569

66-
<script setup>
67-
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
68-
</script>
6970

70-
<VPButton class="api-button" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/@ui5_project_build_ProjectBuilder.html" target="_blank"/>
71+
<div style="margin: 1rem 0;">
72+
<VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/@ui5_project_build_ProjectBuilder.html"/>
73+
</div>
7174

7275
<style>
73-
.api-button {
74-
margin: 1rem 0;
76+
.no-decoration {
77+
text-decoration: inherit;
7578
}
7679
</style>

packages/documentation/docs/pages/Server.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,9 @@ The [UI5 Server](https://github.com/SAP/ui5-server) module provides server capab
66
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
77
</script>
88

9-
<VPButton class="api-button" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/module-@ui5_server.html" target="_blank"/>
10-
11-
<style>
12-
.api-button {
13-
margin: 1rem 0;
14-
}
15-
</style>
9+
<div style="margin: 1rem 0;">
10+
<VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/module-@ui5_server.html"/>
11+
</div>
1612

1713
## Standard Middleware
1814

@@ -86,4 +82,10 @@ Follow the given instructions and enter your password to install the generated c
8682
::: tip
8783
If Chrome unintentionally redirects an HTTP-URL to HTTPS, you need to delete the HSTS mapping in [chrome://net-internals/#hsts](chrome://net-internals/#hsts) by entering the domain name (e.g. localhost) and pressing "delete".
8884

89-
:::
85+
:::
86+
87+
<style>
88+
.no-decoration {
89+
text-decoration: inherit;
90+
}
91+
</style>

packages/documentation/docs/pages/extensibility/CustomServerMiddleware.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ A custom middleware implementation needs to return a function with the following
9191

9292
#### ESM
9393

94-
```js linenums="1
94+
```js
9595
/**
9696
* Custom UI5 Server middleware API
9797
*
@@ -129,7 +129,7 @@ export default function({log, middlewareUtil, options, resources}) {
129129

130130
#### CommonJS
131131

132-
```js linenums="1
132+
```js
133133
/**
134134
* Custom UI5 Server middleware API
135135
*
@@ -169,7 +169,7 @@ module.exports = function({log, middlewareUtil, options, resources}) {
169169

170170
#### ESM
171171

172-
```js linenums="1
172+
```js
173173
import MarkdownIt from "markdown-it";
174174
175175
export default async function({log, middlewareUtil, options, resources}) {
@@ -203,7 +203,7 @@ Live demo of the above example: [openui5-sample-app with custom middleware](http
203203

204204
#### CommonJS
205205

206-
```js linenums="1
206+
```js
207207
module.exports = async function({log, middlewareUtil, options, resources}) {
208208
const MarkdownIt = require("markdown-it");
209209
const md = new MarkdownIt();

packages/documentation/docs/pages/extensibility/CustomTasks.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ A custom task implementation needs to return a function with the following signa
109109

110110
#### ESM
111111

112-
```js linenums="1
112+
```js
113113
/**
114114
* Custom task API
115115
*
@@ -149,7 +149,7 @@ export default async function({dependencies, log, options, taskUtil, workspace})
149149

150150
#### CommonJS
151151

152-
```js linenums="1
152+
```js
153153
/**
154154
* Custom task API
155155
*
@@ -208,7 +208,7 @@ If this callback is not provided, UI5 CLI will make an assumption as to whether
208208

209209
#### ESM
210210

211-
```js linenums="1
211+
```js
212212
/**
213213
* Callback function to define the list of required dependencies
214214
*
@@ -249,7 +249,7 @@ export async function determineRequiredDependencies({availableDependencies, getD
249249

250250
#### CommonJS
251251

252-
```js linenums="1
252+
```js
253253
/**
254254
* Callback function to define the list of required dependencies
255255
*
@@ -300,7 +300,7 @@ result by writing them into the provided `workspace`.
300300

301301
#### ESM
302302

303-
```js linenums="1
303+
```js
304304
import path from "node:path";
305305
import renderMarkdown from "./renderMarkdown.js";
306306
@@ -331,7 +331,7 @@ export default async function({dependencies, log, options, taskUtil, workspace})
331331

332332
#### CommonJS
333333

334-
```js linenums="1
334+
```js
335335
const path = require("node:path");
336336
const renderMarkdown = require("./renderMarkdown.js");
337337

@@ -375,7 +375,7 @@ APIs to retrieve additional information about the project currently being built
375375

376376
#### ESM
377377

378-
```js linenums="1
378+
```js
379379
import path from "node:path";
380380

381381
/*
@@ -425,7 +425,7 @@ export default async function({dependencies, log, options, taskUtil, workspace})
425425
426426
#### CommonJS
427427
428-
```js linenums="1"
428+
```js
429429
const path = require("node:path");
430430
431431
/*

0 commit comments

Comments
 (0)