{"ref":"artifact:ui5-vitepress","page":"/artifacts/ui5-vitepress","json":"/artifacts/ui5-vitepress.json","generated":"2026-11-15","drafted_with_ai":true,"entity":{"id":"ui5-vitepress","name":"UI5 VitePress","artifact_type":"sample","ecosystem":"ui5","serves_ecosystems":["btp"],"flavors":[{"key":"web-components","source":{"url":"https://github.com/hschaefer123/ui5-vitepress","title":"hschaefer123/ui5-vitepress — README, Features","checked":"2026-11-13","quote":"UI5 Web Components implementing the Fiori design system."}}],"domain":"learning-and-reference","secondary_domains":["developer-experience"],"origin_ring":"independent","use_as":"starting-point","description":{"one_line":"A VitePress documentation project to clone and run, with [UI5 Web Components](artifact:ui5-webcomponents) usable in its Vue pages, CDS and ABAP CDS code blocks highlighted, and `cf push` or an MTA build to put it on SAP BTP.","short":"Preconfigured VitePress site with UI5 Web Components, deployed to BTP","what_it_solves":"A VitePress documentation site with its configuration already committed: clone it, `npm install`, `npm run dev`, and the dev server opens at `http://localhost:5173`. Inside it are [UI5 Web Components](artifact:ui5-webcomponents) usable in any Vue single-file component, with a mixin that switches their theme when VitePress's dark mode switch is thrown, and Tailwind CSS v4 imported as layers in `.vitepress/theme/custom.css` without Preflight, because VitePress brings its own reset, with a Fire and Water palette declared as `@theme` variables. Shiki grammars for CAP CDS and ABAP CDS are preconfigured, so a `cds` or `abapcds` fenced block is highlighted the way a `ts` block is, and a `plantuml` block becomes a diagram. The getting-started guide writes out two SAP deployment paths: `cf push` onto the [Cloud Foundry runtime](artifact:btp-cloud-foundry-runtime) with the Staticfile buildpack and a 32 MB manifest, and an MTA build that zips the built site into the [HTML5 Application Repository](artifact:btp-html5-application-repository) for SAP Work Zone, after which the `base` path in `.vitepress/config.ts` has to be set to the deployed app's URL. What you take away is the clone: there is no package to install into a site you already have, and the theme and the palette are edited in your own copy.","to_build_on_it":"The theme is the project's own code under `.vitepress/theme`, so a component or a colour is changed in the clone, and a further language is a tmLanguage JSON file dropped into `.vitepress/syntaxes` and named in `config.ts`. Controlling who may read the published site is what the second deployment path is for: the guide says access control needs a managed or unmanaged SAP Application Router, and writes out an `mta.yaml` with an `xs-security.json` beside a `cf` folder holding the app descriptor and `xs-app.json`, none of which the repository ships. That path also wants four devDependencies (bestzip, copyfiles, mbt, rimraf) with the npm scripts that run the mbt build and the `cf deploy`, and the HTML5 Application Repository it uploads into has a default size of under 5 MB."},"links":{"repo":"https://github.com/hschaefer123/ui5-vitepress","homepage":"https://hschaefer123.github.io/ui5-vitepress/"},"maintainers":["actor:hschaefer123"],"compat":{"runtimes":["node"]},"requires":[{"ref":"external:vitepress","for":"The static site generator the project is a configuration of: the pages are markdown it compiles, and `dev`, `build` and `preview` in `package.json` are its commands.","requirement":"required","basis":"binding","role":"framework","sources":[{"url":"https://raw.githubusercontent.com/hschaefer123/ui5-vitepress/main/src/guide/index.md","title":"UI5 VitePress — What is UI5 VitePress?, Dependencies","checked":"2026-11-13","quote":"The static site is build with [VitePress](https://vitepress.dev/), a [markdown](https://en.wikipedia.org/wiki/Markdown)-centered [Static Site Generator (SSG)](https://en.wikipedia.org/wiki/Static_site_generator) using the [Vite](https://vitejs.dev/) development environment and [Rollup](https://rollupjs.org/guide/en/) module bundler."},{"url":"https://github.com/hschaefer123/ui5-vitepress","title":"hschaefer123/ui5-vitepress — README","checked":"2026-11-13","quote":"Pre-configured “Ready to Run” solution to get started immediately with VitePress and UI5."}]},{"ref":"artifact:ui5-webcomponents","for":"The UI elements the site's own Vue components are built from; the preconfigured theme ships a mixin that switches their theme together with VitePress's dark mode switch.","requirement":"required","basis":"binding","role":"component-library","sources":[{"url":"https://github.com/hschaefer123/ui5-vitepress","title":"hschaefer123/ui5-vitepress — README, Features","checked":"2026-11-13","quote":"UI5 Web Components implementing the Fiori design system."},{"url":"https://raw.githubusercontent.com/hschaefer123/ui5-vitepress/main/src/guide/ui5wc.md","title":"UI5 VitePress — UI5 Web Components, Toogle Dark Mode Mixin","checked":"2026-11-13","quote":"To support the VitePress ``Dark Mode Switch``, the ``Pre-configured`` solutions offers a Mixin, that handles theme switching automatially."}]},{"ref":"artifact:btp-cloud-foundry-runtime","for":"Where the built `site` directory runs when it is pushed to SAP BTP: `cf push` with the Staticfile buildpack named in the project's `manifest.yaml`.","requirement":"conditional","basis":"binding","role":"deployment-target","condition":"the site is deployed to SAP BTP Cloud Foundry with cf push","sources":[{"url":"https://raw.githubusercontent.com/hschaefer123/ui5-vitepress/main/src/guide/getting-started.md","title":"UI5 VitePress — Getting Started, Deployment, SAP BTP","checked":"2026-11-13","quote":"Deploy your builded site directory to SAP BTP CloudFoundry using the following ``manifest.yaml`` file leveraging the [Staticfile buildpack](https://docs.cloudfoundry.org/buildpacks/staticfile/)"}]},{"ref":"artifact:btp-html5-application-repository","for":"Where the zipped build is uploaded on the Work Zone path, built and deployed with the mta tools and served afterwards through the managed Application Router.","requirement":"conditional","basis":"binding","role":"hosting","condition":"the site is deployed for SAP Work Zone through the managed Application Router","sources":[{"url":"https://raw.githubusercontent.com/hschaefer123/ui5-vitepress/main/src/guide/getting-started.md","title":"UI5 VitePress — Getting Started, Deployment, SAP WorkZone","checked":"2026-11-13","quote":"The following example shows how to use the mta tools to build and deploy to the ``HTML5 Content Repository`` while accessing using the Managed Application Router of the SAP WorkZone."}]}],"provenance":{"discovered_via":[{"source":"source:github"}],"first_seen":"2026-11-13"},"drafted_with_ai":true},"effective_normative_relations":[],"readings":{"liveness":[{"label":"Maintenance","tier":"unknown","evidence":"no release data"},{"label":"Continuity","tier":"fair","evidence":"one contributor, personally owned"},{"label":"Repository","tier":"good","evidence":"pushed 2026-08, not archived"}],"compatibility":[{"label":"Declared for","tier":"unknown","evidence":"no UI5 release lines in the atlas"},{"label":"Survived majors","tier":"unknown","evidence":"no UI5 release lines in the atlas"},{"label":"Maintainer's CI","tier":"good","evidence":"Deploy VitePress site to Pages green, 2026-08-16"}],"practice":[{"label":"Tests","tier":"fair","evidence":"none found in the tree"},{"label":"Docs","tier":"fair","evidence":"README 1 KB"},{"label":"Changelog","tier":"fair","evidence":"none in the repo"}],"reach":[{"value":null,"unit":"installs/week"},{"value":12,"unit":"watching"}]},"signals":{"crawled_at":"2026-11-13","npm":"not published under this name","stars":12,"forks":1,"open_issues":0,"archived":false,"pushed_at":"2026-08-16","language":"Vue","license_spdx":"MIT","org_owned":false,"default_branch":"main","created_at":"2023-09-27T14:07:22Z","open_prs":0,"tree_truncated":false,"test_files":0,"workflows":1,"other_ci":false,"readme_bytes":1332,"docs_files":0,"changelog":false,"license_file":true,"dts_files":3,"first_commit":"2023-09-27","last_commit":"2026-08-16","commits":42,"contributors":1,"ci_status":"success","ci_run_at":"2026-08-16","ci_workflow":"Deploy VitePress site to Pages","ci_event":"push","readme_path":"README.md","readme_sha":"cd06d073373f11d0acf4b42a6cebd89d6b696c28","repo_read":"2026-11-13"},"edges":{"maintainers":[{"ref":"actor:hschaefer123","name":"Holger Schäfer","json":"/actors/hschaefer123.json"}],"contributors":[],"explained_by":[],"alternative_to_this":[],"needed_by":[],"available_via":[],"parts":[],"add_ons":[],"answered_through_parts":[]}}