Skip to content

Commit c839176

Browse files
d3xter666d3xter666
committed
refactor: Use vitepress buttons
1 parent 977886e commit c839176

File tree

7 files changed

+57
-22
lines changed

7 files changed

+57
-22
lines changed

‎packages/documentation/docs/index.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ next:
66

77
<script setup>
88
import { useData } from 'vitepress'
9+
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
910
const { isDark } = useData()
1011
</script>
1112

@@ -30,9 +31,7 @@ And checkout the **[Migrate to v4](./updates/migrate-v4)** documentation.
3031
:::
3132

3233
<div style="margin: 2rem 0;">
33-
<a href="./pages/GettingStarted" style="display: inline-block; padding: 12px 24px; background: #1976d2; color: white; text-decoration: none; border-radius: 6px; font-weight: 600;">
34-
🚀 Get Started
35-
</a>
34+
<VPButton class="no-decoration" text="🚀 Get Started" href="./pages/GettingStarted"/>
3635
</div>
3736

3837
## Main Features

‎packages/documentation/docs/pages/Benchmarking.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,11 @@ The following is a walk-through on how to evaluate the performance impact of an
102102
1. Prepare your change
103103
1. Switch to the branch that contains your change
104104
```sh
105-
(cd ../pages/ui5-builder && git checkout my-change)
105+
(cd ../pages/builder && git checkout my-change)
106106
```
107107
1. If your change requires different npm dependencies, reinstall them
108108
```sh
109-
(cd ../pages/ui5-builder && npm install)
109+
(cd ../pages/builder && npm install)
110110
```
111111
1. The link from UI5 CLI is still in place. However, if you have changes in **multiple** UI5 CLI modules, you might need to `npm link` those again
112112

‎packages/documentation/docs/pages/Builder.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

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

5+
<script setup>
6+
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
7+
</script>
8+
59
Based on a project's type, the UI5 Builder defines a series of build steps to execute; these are also called "tasks".
610

711
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.
812

913
<div style="margin: 1rem 0;">
10-
<a href="https://ui5.github.io/cli/v4/api/index.html" target="_blank" style="display: inline-block; padding: 8px 16px; background: #1976d2; color: white; text-decoration: none; border-radius: 4px; font-weight: 600; font-size: 14px;">
11-
📚 API Reference
12-
</a>
14+
<VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/index.html"/>
1315
</div>
1416

1517
## Tasks
@@ -191,4 +193,9 @@ sap.ui.define([], () => {
191193
});
192194
```
193195

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

‎packages/documentation/docs/pages/FileSystem.md‎

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

33
The [UI5 FS](https://github.com/SAP/ui5-fs) provides a UI5-specific file system abstraction.
44

5+
<script setup>
6+
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
7+
</script>
8+
59
<div style="margin: 1rem 0;">
6-
<a href="https://ui5.github.io/cli/v4/api/" target="_blank" style="display: inline-block; padding: 8px 16px; background: #1976d2; color: white; text-decoration: none; border-radius: 4px; font-weight: 600; font-size: 14px;">
7-
📚 API Reference
8-
</a>
10+
<VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/"/>
911
</div>
1012

1113
## Overview
@@ -45,3 +47,9 @@ They implement the same API for **retrieving** resources as adapters (`byPath` a
4547
* [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
4648
* [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
4749
* [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/Project.md‎

Lines changed: 11 additions & 3 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

@@ -65,7 +69,11 @@ In the table below you can find the available combinations of project type & out
6569

6670

6771
<div style="margin: 1rem 0;">
68-
<a href="https://ui5.github.io/cli/v4/api/@ui5_project_build_ProjectBuilder.html" target="_blank" style="display: inline-block; padding: 8px 16px; background: #1976d2; color: white; text-decoration: none; border-radius: 4px; font-weight: 600; font-size: 14px;">
69-
📚 API Reference
70-
</a>
72+
<VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/@ui5_project_build_ProjectBuilder.html"/>
7173
</div>
74+
75+
<style>
76+
.no-decoration {
77+
text-decoration: inherit;
78+
}
79+
</style>

‎packages/documentation/docs/pages/Server.md‎

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

33
The [UI5 Server](https://github.com/SAP/ui5-server) module provides server capabilities for local development of UI5 projects.
44

5+
<script setup>
6+
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
7+
</script>
8+
59
<div style="margin: 1rem 0;">
6-
<a href="https://ui5.github.io/cli/v4/api/module-@ui5_server.html" target="_blank" style="display: inline-block; padding: 8px 16px; background: #1976d2; color: white; text-decoration: none; border-radius: 4px; font-weight: 600; font-size: 14px;">
7-
📚 API Reference
8-
</a>
10+
<VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/module-@ui5_server.html"/>
911
</div>
1012

1113
## Standard Middleware
@@ -80,4 +82,10 @@ Follow the given instructions and enter your password to install the generated c
8082
::: tip
8183
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".
8284

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

‎packages/documentation/docs/pages/index.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<script setup>
22
import { useData } from 'vitepress'
3+
import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue"
34
const { isDark } = useData()
45
</script>
56

@@ -24,9 +25,7 @@ And checkout the **[Migrate to v4](../updates/migrate-v4)** documentation.
2425
:::
2526

2627
<div style="margin: 2rem 0;">
27-
<a href="./GettingStarted" style="display: inline-block; padding: 12px 24px; background: #1976d2; color: white; text-decoration: none; border-radius: 6px; font-weight: 600;">
28-
🚀 Get Started
29-
</a>
28+
<VPButton class="no-decoration" text="🚀 Get Started" href="./GettingStarted"/>
3029
</div>
3130

3231
## Main Features
@@ -147,3 +146,9 @@ async function buildApp(projectPath, destinationPath) {
147146
});
148147
}
149148
```
149+
150+
<style>
151+
.no-decoration {
152+
text-decoration: inherit;
153+
}
154+
</style>

0 commit comments

Comments
 (0)