https://github.com/shopware/developer-documentation-vitepress

This is a new template for the frontend of our developer documentation.
https://github.com/shopware/developer-documentation-vitepress

docs

Last synced: 2 months ago
JSON representation

This is a new template for the frontend of our developer documentation.

• Host: GitHub
• URL: https://github.com/shopware/developer-documentation-vitepress
• Owner: shopware
• License: other
• Created: 2022-01-26T11:04:09.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-05T09:49:18.000Z (2 months ago)
• Last Synced: 2024-04-05T16:29:53.927Z (2 months ago)
• Topics: docs
• Language: TypeScript
• Homepage: https://shopware-developer-beta.netlify.app/theme.html
• Size: 35.1 MB
• Stars: 6
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Lists

• awesome-vitepress-v1 - shopware-developer-documentation-vitepress

README

        
# Shopware Developer Platform Theme

This is a base theme for all developer documentation websites in the Shopware Product ecosystem.

Please follow the:

- [setup instructions](./SETUP.md) for more information on how to use this theme.

- [features](./FEATURES.md) for more information on globally available features.

- [`developer-portal`](/shopware/developer-portal) for the actual implementation of this library.

## Collaboration

To prepare a new release version, run the `pnpm bump` command.

```bash

$ pnpm bump

```

Push changes to the remote and let the `auto-publish` workflow run the tests and publish new versions.

## Versioning

There are 2 versions of documentation template available:

- ~~v0.x (branch `v0`) - hard-forked version of old VueJS theme~~

- v1.x (branch `main`) - extended version of the official Vitepress theme

## Directory structure

- `src` as 'vitepress-shopware-docs' - Shopware specific Vitepress theme

- [`packages/cli`](./CLI.md) as `@shopware-docs/cli` - CLI used for embedding repositories

- `packages/storybook` as `@shopware-docs/storybook` - shared Storybook configuration, including mocks

- `packages/vitepress` as `@shopware-docs/vitepress` - shared Vitepress plugins and helpers

- `packages/vitest` as `@shopware-docs/vitest` - shared vitest & Playwright configuration