documentation_builder

Description:

documentation builder

documentation_builder #
Generates markdown documentation files from markdown template files.
This can be useful when you write documentation for a
Dart or Flutter project
and want to reuse/import Dart code or Dart documentation comments.
It can generate the following files:

ReadMeFile
ChangeLogFile
ExampleFile
GitHub [WikiTemplateFile]s

documentation_builder is not intended to generate API documentation.
Use dartdoc instead.

Examples #
The DocumentationBuilders own documentation was generated by itself and also serves as show case.
You can view the templates files and the generated output on https://github.com and https://pub.dev:

README

Markdown Template File
Generated Markdown File Raw
Generated Markdown File Rendered


LICENSE

Markdown Template File
Generated Markdown File Raw


CHANGELOG

TODO (GitHubRaw suffix='/main/doc/template/CHANGELOG.mdt' title='Markdown Template File']
TODO (GitHubRaw suffix='/main/CHANGELOG.md' title='Generated Markdown File Raw']
Generated Markdown Rendered


Wiki pages

Markdown Template Files (select a file and select raw to see the source)
Generated Markdown Files Rendered


example

Markdown Template File
Generated Markdown File Raw
Generated Markdown Page Rendered




Getting Started #

Read the Wiki documentation
Install the documentation_builder package in your project
Add a build.yaml file to the root of your project with the following lines (merge lines if build.yaml file already exists):
targets:
$default:
sources:
- doc/**
- lib/**
- bin/**
- test/**
- pubspec.*
- $package$
copied to clipboard

Create 'doc/template' directories in the root of your project
Create markdown template files in the "doc/template" directory (see examples)
Generate the documentation files
Publish the documentation files