Acasă Explorează Ajutor
Autentificare
cturan
/
vendure
oglindă de https://github.com/vendure-ecommerce/vendure
1
0
Bifurcare 0
Fisiere Probleme 0 Wiki
Arbore: 57d3736452
Ramuri Etichete
vendure
/
docs
David Höck 57d3736452 fix(docs): Add missing @types/node dependency 1 zi în urmă
..
docs 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 1 zi în urmă
scripts 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 1 zi în urmă
src 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 1 zi în urmă
.gitignore 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 1 zi în urmă
.npmignore 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 1 zi în urmă
CLAUDE.md 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 1 zi în urmă
README.md 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 1 zi în urmă
package-lock.json 57d3736452 fix(docs): Add missing @types/node dependency 1 zi în urmă
package.json 57d3736452 fix(docs): Add missing @types/node dependency 1 zi în urmă
tsconfig.build.json 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 1 zi în urmă
tsconfig.json 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 1 zi în urmă

README.md

@vendure/docs

This package contains the official documentation for Vendure, the open-source headless e-commerce framework.

Overview

The @vendure/docs package provides:

  • Guides: Getting started, core concepts, developer guides, and how-to tutorials
  • Reference Documentation: TypeScript API, GraphQL API (Admin & Shop), and plugin documentation
  • User Guide: End-user documentation for the Admin UI

Usage

This package is designed to be consumed by the Vendure documentation platform. It exports a manifest that describes the structure and location of all documentation files.

import { manifest } from '@vendure/docs/manifest';

Structure

  • docs/ - MDX documentation files organized by category
  • dist/ - Compiled TypeScript exports
  • src/manifest.ts - Documentation manifest defining navigation structure

Links

License

This package is part of the Vendure project and is licensed under the GPL v3 license.