documentation_builder 0.0.1
documentation_builder: ^0.0.1 copied to clipboard

Generates markdown documentation files from markdown template files.

Pub Package Code Repository Github Wiki GitHub Stars GitHub License GitHub Issues GitHub Pull Requests

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:

  • README.md file
  • CHANGELOG.mdt file
  • example.md file
  • Github Wiki pages (also markdown files)

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

Examples #

The [DocumentationBuilder]s 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:

Getting Started #

  • Read the Wiki documentation
  • [PubDevInstall title='Install the documentation_builder package'] in your project
  • Create 'doc/template' directories in the root of your project
  • [02-Markdown-Template-Files.mdt title='Create markdown template files'] in the "doc/template" directory ([06-Examples.mdt title='see examples'])
  • [05-Generating-Documentation-Files.mdt title='Generate the documentation files']