صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
cturan
/
vendure
mirrorاز https://github.com/vendure-ecommerce/vendure
1
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: 478068daa5
شاخه‌ها تگ‌ها
vendure
/
docs
David Höck 478068daa5 fix(docs): Generate dates file before running MDX tests 2 روز پیش
..
docs 5aabf4c247 fix(docs): Use bracket syntax for admonition titles 2 روز پیش
scripts 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 2 روز پیش
src 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 2 روز پیش
.gitignore 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 2 روز پیش
.npmignore 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 2 روز پیش
CLAUDE.md 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 2 روز پیش
README.md 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 2 روز پیش
package-lock.json 57d3736452 fix(docs): Add missing @types/node dependency 2 روز پیش
package.json 478068daa5 fix(docs): Generate dates file before running MDX tests 2 روز پیش
tsconfig.build.json 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 2 روز پیش
tsconfig.json 0eaf1e7390 feat(docs): Migrate documentation to @vendure/docs package (#4124) 2 روز پیش

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.