I Pointed Sourcey at a Real Local API. Here Is What It Actually Produced.

Описание и применение

Sourcey создал статический сайт документации из реального API и Markdown‑руководства, избавив от необходимости сервера документации.

Задача

Integrating a documentation generator into an existing project with a real API contract and prose guide without adding a runtime documentation server.

Результат

Sourcey produced a complete, static documentation bundle from a real API contract and a Markdown guide, eliminating the need for a documentation server and reducing maintenance overhead.

Рабочий процесс

• 1. Add Sourcey as a local dependency via npm
• 2. Run npm install to install dependencies
• 3. Execute npm run docs:build (internally sourcey build)
• 4. Verify output in dist/ directory (api.html, index.html, introduction.html, etc.)
• 5. Deploy the static dist/ folder to a static host or CI pipeline

Доказательства

Sourcey: building documentation site Pages: 2 Output: ...\sourcey-frantic-127-demo\dist Time: 92.1s

Источник

The output directory contained 11 files totaling 440,495 bytes

Источник