Quickstart

fundoc - Documentation Generator

Overview

fundoc is a language agnostic documentation generator. Generate documentation from code comments and structure.

Quick Start

Generate documentation

sc fundoc generate docs <path>

Passthrough to fundoc CLI

sc fundoc _ <fundoc-args>

Key Features

• Language Agnostic: Works with multiple programming languages
• Code Comments: Extract documentation from code comments
• Structure Analysis: Analyze code structure for docs
• Plugins: Extensible via plugins
• GitHub Action: Available as GitHub Action
• Literate Programming: Supports literate programming style

Installation

cargo install fundoc

Usage Examples

Generate docs from current directory

fundoc

Generate docs from specific path

fundoc src/

Specify output format

fundoc --format markdown src/

Use specific plugin

fundoc --plugin rust src/

Notes

• Run fundoc --help to see all available options