Michael Bromley 01cc143352 docs(server): Add some docs about the docs		před 7 roky
..
archetypes	0b00db96a1 feat(docs): Initial setup of Hugo docs website	před 7 roky
assets	ed136af68b docs(server): Implement linking between types in docs pages	před 7 roky
content	81240f354c docs(server): Generate docs for config interfaces	před 7 roky
diagrams	91de6beb2b feat(server): Refine customer signup flow	před 7 roky
layouts	81240f354c docs(server): Generate docs for config interfaces	před 7 roky
static	5270af78af feat(docs): Incorporate landing page in docs website, styling	před 7 roky
README.md	01cc143352 docs(server): Add some docs about the docs	před 7 roky
config.toml	7b5dcbf829 feat(docs): Improve docs nav menu: correct ordering & expand sections	před 7 roky
tsconfig.json	ddaee4fd71 feat(docs): Highlight current section in table of contents	před 7 roky

Vendure Docs

This is the source for the Vendure documentation website. Docs are written in markdown and the website is generated with Hugo.

Currently requires the extended Hugo binary (for Sass support).

API Docs Generation

The API docs are generated from the TypeScript source files by running the "generate-docs" script:

yarn generate-docs [-w]

This script uses the TypeScript compiler API to traverse the server source code and extract data about the types as well as other information such as descriptions and default values.

Currently, any interface which includes the JSDoc @docCategory tag will be extracted into a markdown file in the content/docs/api directory. Hugo can then build the API documentation from these markdown files. This will probably be expanded to be able to parse class and type declarations too.

README.md

Vendure Docs

API Docs Generation