Почетна Преглед Помоћ
Пријавите се
cturan
/
vendure
огледало од https://github.com/vendure-ecommerce/vendure
1
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: b8e98cca8c
Гране Ознаке
vendure
/
docs
David Höck b8e98cca8c docs: Update docs-provider to 0.10.0 and use runAllTests пре 2 дана
..
docs 6cf333288e docs: Fix console block syntax in installation guide пре 4 дана
scripts b8e98cca8c docs: Update docs-provider to 0.10.0 and use runAllTests пре 2 дана
src b11e740a67 docs: Add missing user-guide pages to manifest пре 3 дана
.gitignore 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) пре 1 недеља
.npmignore 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) пре 1 недеља
CLAUDE.md 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) пре 1 недеља
README.md 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) пре 1 недеља
package-lock.json b8e98cca8c docs: Update docs-provider to 0.10.0 and use runAllTests пре 2 дана
package.json b8e98cca8c docs: Update docs-provider to 0.10.0 and use runAllTests пре 2 дана
tsconfig.build.json 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) пре 1 недеља
tsconfig.json 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) пре 1 недеља

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.