flutter_markdown 0.3.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 95

Flutter Markdown #

pub package Build Status

A markdown renderer for Flutter. It supports the original format, but no inline html.

Getting Started #

Using the Markdown widget is simple, just pass in the source markdown as a string:

Markdown(data: markdownSource);

If you do not want the padding or scrolling behavior, use the MarkdownBody instead:

MarkdownBody(data: markdownSource);

By default, Markdown uses the formatting from the current material design theme, but it's possible to create your own custom styling. Use the MarkdownStyle class to pass in your own style. If you don't want to use Markdown outside of material design, use the MarkdownRaw class.

Image support #

The Img tag only supports the following image locations:

  • From the network: Use a URL prefixed by either http:// or https://.

  • From local files on the device: Use an absolute path to the file, for example by concatenating the file name with the path returned by a known storage location, such as those provided by the path_provider plugin.

  • From image locations referring to bundled assets: Use an asset name prefixed by resource:. like resource:assets/image.png.

0.3.0 #

  • Supporting GitHub flavoured Markdown
  • Supporting strikethrough
  • Convert TextSpan to use new InlineSpan API

0.2.0 #

  • Updated environment sdk constraints to make the package Dart 2 compatible. As a result, usage of this version and higher requires a Dart 2 SDK.

0.1.6 #

  • Updated markdown dependency.

0.1.5 #

  • Add mockito as a dev dependency. Eliminate use of package:http, which is no longer part of Flutter.

0.1.4 #

  • Add li style to bullets

0.1.3 #

  • Add path and http as declared dependencies in pubspec.yaml

0.1.2 #

  • Add support for horizontal rules.
  • Fix the onTap callback on images nested in hyperlinks

0.1.1 #

  • Add support for local file paths in image links. Make sure to set the imageDirectory property to specify the base directory containing the image files.

0.1.0 #

  • Roll the dependency on markdown to 1.0.0
  • Add a test and example for image links
  • Fix the onTap callback on hyperlinks

0.0.9 #

  • First published version

example/README.md

flutter_markdown_example #

Demonstrates how to use the flutter_markdown package.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_markdown: ^0.3.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_markdown/flutter_markdown.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
98
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
95
Learn more about scoring.

We analyzed this package on Nov 15, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.0
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.6

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.5.0 <3.0.0
flutter 0.0.0
markdown ^2.0.0 2.1.2
meta ^1.1.7 1.1.7 1.1.8
Transitive dependencies
args 1.5.2
charcode 1.1.2
collection 1.14.11 1.14.12
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test
mockito ^3.0.0