English | 한국어

Docflow is a TypeScript-first documentation generator that automatically creates API documentation from JSDoc comments.

• Docflow automatically generates comprehensive documentation from JSDoc comments, supporting essential tags like @public, @category, and @example.
• Designed with AI integration in mind, Docflow can generate complete JSDoc comments for your functions with a single @generate tag.
• Docflow provides accurate TypeScript type extraction, ensuring your documentation always matches your actual code signatures.
• Docflow includes a powerful plugin system, allowing you to generate documentation for VitePress, Docusaurus, Nextra, and more.

import { createCalculator } from "@toss/utils"; /**  * @public  * @category Math  * Creates a calculator instance with the given initial value  * @param initialValue - The starting value for calculations  * @returns A calculator object with calculation methods  * @example  * const calc = createCalculator(10);  * calc.add(5).multiply(2).getValue(); // 30  */ export function createCalculator(initialValue: number) { return { add: (n: number) => createCalculator(initialValue + n), multiply: (n: number) => createCalculator(initialValue * n), getValue: () => initialValue, }; }

With just docflow build, this becomes a beautiful documentation page with examples, type information, and more.

We welcome contribution from everyone in the community. Read below for detailed contribution guide.

CONTRIBUTING

MIT © Toss. See LICENSE for details.