首頁 探索 說明
登入
cturan
/
vendure
镜像来自 https://github.com/vendure-ecommerce/vendure
1
0
複刻 0
檔案 問題管理 0 Wiki
目錄樹: 38326acb9c
分支列表 標籤列表
vendure
/
docs
David Höck 38326acb9c chore(docs): Update generated API reference docs 1 天之前
..
docs 38326acb9c chore(docs): Update generated API reference docs 1 天之前
src 07f154ab2f feat(docs): Generate index files with LinkCards for API reference folders 1 天之前
.gitignore d83725a1bc feat(docs): Set up npm publish workflow for @vendure/docs 6 天之前
.npmignore d83725a1bc feat(docs): Set up npm publish workflow for @vendure/docs 6 天之前
README.md 7148f80bb6 docs(docs): Update manifest ID to 'core' and add README 2 天之前
package-lock.json 38326acb9c chore(docs): Update generated API reference docs 1 天之前
package.json 38326acb9c chore(docs): Update generated API reference docs 1 天之前
tsconfig.build.json d83725a1bc feat(docs): Set up npm publish workflow for @vendure/docs 6 天之前
tsconfig.json d83725a1bc feat(docs): Set up npm publish workflow for @vendure/docs 6 天之前

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.