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.
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 buildAlternatives
Packages that do the same job and could replace documentation_builder.
- source_gen
Source code generation builders and utilities for the Dart build system.
84Compare - copy_with_extension_gen
Generate type‑safe copyWith extensions for annotated classes and record typedefs.
85Compare - embed
Generates Dart code that embeds arbitrary file contents as literals.
75Compare - json_serializable
Automatically generate code for converting Dart classes to and from JSON.
94Compare
Works with
Packages commonly used together with documentation_builder: ones it builds on, ones built on it, and its own family.
- analyzerdocumentation_builder depends on itPerforms static analysis of Dart code for tool integration and embedding.
- cryptodocumentation_builder depends on itProvides SHA, MD5, and HMAC hashing functions for Dart.
- globdocumentation_builder depends on itA file and directory globbing library that supports Bash-style path matching and listing.
- package_configdocumentation_builder depends on itRead and write Dart package configuration files.
- petitparserdocumentation_builder depends on itBuild fast, composable, and type-safe grammars and parsers in plain Dart code.
- loggingdocumentation_builder depends on itProvides configurable logging with levels and stream listeners for Dart apps.
- builddocumentation_builder depends on itPackage for authoring build_runner compatible code generators.
- build_configdocumentation_builder depends on itFormat definition and support for parsing build.yaml configuration.