Skip to content
pubscout

documentation_builder

2.0.2, released 3 weeks ago by an unverified publisher

Generates documentation files from template files, importing other files or Dart documentation comments.

$ flutter pub add documentation_builder
Source repository

What it does

Generates various documentation files like README.md, LICENSE, CHANGELOG.md, and GitHub wiki pages from templates. It reuses and imports files or Dart documentation comments using a template engine.

AI-written summary of version 2.0.2, based on the package's README and metadata. Report an inaccuracy

Use it when

  • You want to automate the generation of your project's documentation and markdown files from templates
  • You want to pull Dart documentation comments directly into your documentation files

Skip it when

  • You are looking to generate traditional API documentation (use dartdoc instead)

Strengths

  • Simplifies keeping documentation up to date with code comments and other files
  • Integrates with build_runner for automated generation
  • Includes setup commands for easy project initialization

Weaknesses

  • Not intended for generating API documentation

Setup

Kind
Pure Dart
Effort
Low
Code generation
Yes (build_runner)
Direct dependencies
15

Can be set up using 'documentation_builder setup' or manually by adding build_runner and documentation_builder as dev dependencies and configuring build.yaml.

documentation_builder build

Alternatives

Packages that do the same job and could replace documentation_builder.

Works with

Packages commonly used together with documentation_builder: ones it builds on, ones built on it, and its own family.