hschaefer123/ui5-vitepress

Pre-configured “Ready to Run” solution to get started immediately with VitePress and UI5.

UI5 VitePress

Pre-configured “Ready to Run” solution to get started immediately with VitePress and UI5.

Live Demo (see .github/workflows/deploy.yml)

Fire and Water Design System

Features

• Vue based Single-File Components (SFC)
• UI5 Web Components implementing the Fiori design system.
• PostCSS preprocessor transforming CSS with plugins:
  • Tailwind CSS enabling a utility-first driven design system.
  • Autoprefixer adding vendor prefixes to CSS rules.
  • cssnano optimizing for production with modern CSS compression.
• PlantUML creating diagrams from plain text.
• Deployment
  • GitHub Pages using actions
  • BTP using manifest

Installation

1. Clone the repo

   git clone https://github.com/hschaefer123/ui5-vitepress.git

2. Install NPM packages

   npm install

3. Start dev server using

   npm run dev

The dev server automatically opens a browser window at http://localhost:5173.

Everything else can be found in the application.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Holger Schäfer - @hschaefer123

UDINA Business Technology Platform: https://btp.udina.de

ui5-vitepress's Issues

Error when executing `npm run dev`

Hi @hschaefer123,
I have cloned the repository and installed the npm dependencies as described in the readme.
However, I get following error message:

▶ npm run dev

> [email protected] dev
> vitepress --open

failed to start server. error:
Error: [shikiji] Language `cds` not found, you may need to load it first
    at Object.getLangGrammar (file:///Users/myuser/git/ui5-vitepress/node_modules/shikiji/dist/core.mjs:668:13)
    at codeToThemedTokens (file:///Users/myuser/git/ui5-vitepress/node_modules/shikiji/dist/core.mjs:4498:28)
    at file:///Users/myuser/git/ui5-vitepress/node_modules/shikiji/dist/core.mjs:4625:26
    at Array.map (<anonymous>)
    at codeToTokensWithThemes (file:///Users/myuser/git/ui5-vitepress/node_modules/shikiji/dist/core.mjs:4625:15)
    at codeToHast (file:///Users/myuser/git/ui5-vitepress/node_modules/shikiji/dist/core.mjs:4684:25)
    at codeToHtml (file:///Users/myuser/git/ui5-vitepress/node_modules/shikiji/dist/core.mjs:4882:23)
    at Object.codeToHtml (file:///Users/myuser/git/ui5-vitepress/node_modules/shikiji/dist/core.mjs:4894:37)
    at Object.highlight (file:///Users/myuser/git/ui5-vitepress/node_modules/vitepress/dist/node/serve-ao1ovSY4.js:46663:37)
    at default_rules.fence (file:///Users/myuser/git/ui5-vitepress/node_modules/vitepress/dist/node/serve-ao1ovSY4.js:34803:27)

Can you confirm that this happens also on your side?

I tried it with node version (18 and 20).

Failing CI regarding GH Actions

I think the CI currently fails on the default branch because gh pages is not set to "GH Actions" in the settings.

On my fork it runs fine