首页 发现 帮助
登录
cturan
/
vendure
镜像自地址 https://github.com/vendure-ecommerce/vendure
1
0
派生 0
文件 工单管理 0 Wiki
分支: docs-v2-migration
分支列表 标签列表
vendure
/
docs
David Höck 7148f80bb6 docs(docs): Update manifest ID to 'core' and add README 7 小时之前
..
docs d1885262c7 feat(docs): Migrate GraphQL docs to use GraphQLDoc component 4 天之前
src 7148f80bb6 docs(docs): Update manifest ID to 'core' and add README 7 小时之前
.gitignore d83725a1bc feat(docs): Set up npm publish workflow for @vendure/docs 4 天之前
.npmignore d83725a1bc feat(docs): Set up npm publish workflow for @vendure/docs 4 天之前
README.md 7148f80bb6 docs(docs): Update manifest ID to 'core' and add README 7 小时之前
package-lock.json f6fb8d7021 fix(docs): Fix manifest file paths and add missing index files 4 天之前
package.json 7148f80bb6 docs(docs): Update manifest ID to 'core' and add README 7 小时之前
tsconfig.build.json d83725a1bc feat(docs): Set up npm publish workflow for @vendure/docs 4 天之前
tsconfig.json d83725a1bc feat(docs): Set up npm publish workflow for @vendure/docs 4 天之前

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.