documentation_builder 0.0.1

Generates markdown documentation files from markdown template files.

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:

• README
  • Markdown Template File
  • Generated Markdown File Raw
  • [PubDev title='Generated Markdown File Rendered']
• CHANGELOG
  • Markdown Template File
  • Generated Markdown File Raw
  • [PubDevProjectVersions title='Generated Markdown Rendered']
• Wiki pages
  • Markdown Template Files (select a file and select raw to see the source)
  • Generated Markdown Files (select a file and select raw to see the source)
  • Generated Markdown Files Rendered
• example
  • Markdown Template File
  • Generated Markdown File Raw
  • [PubDevExample title='Generated Markdown Page Rendered']

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']