flutter_markdown 0.3.4

  • 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.4 #

  • Add the support for text paragraphs and blockquotes.

0.3.3 #

  • Add the ability to control the scroll position of the MarkdownWidget.

0.3.2 #

  • Uplift package:markdown dependency version to enable deleting HTML unescape URI workaround
  • Explictly state that Flutter 1.10.7 is the minimum supported Flutter version in the library pubspec.yaml.

0.3.1 #

  • Expose tableColumnWidth
  • Add MarkdownStyleSheet.fromCupertinoTheme
  • Fix MarkdownStyleSheet.blockquote
  • Flutter for web support
  • Add physic and shrinkWrap to Markdown widget
  • Add MarkdownBody.fitContent
  • Support select text to copy
  • Fix list bullet alignment
  • HTML unescape URIs (temporary workaround for dart-lang/markdown #272)
  • Rebuilt example/android and example/ios directories

Note: this version has an implicit minimum supported version of Flutter 1.10.7. See flutter/flutter_markdown issue #156 for more detail.

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


// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/material.dart';
import 'package:flutter_markdown/flutter_markdown.dart';

const String _markdownData = """
# Markdown Example
Markdown allows you to easily include formatted text, images, and even formatted Dart code in your app.

## Titles


This is an H1

This is an H2


# This is an H1

## This is an H2

###### This is an H6

Select the valid headers:

- [x] `# hello`
- [ ] `#hello`

## Links

[Google's Homepage][Google]



## Images

![Flutter logo](/dart-lang/site-shared/master/src/_assets/image/flutter/icon/64.png)

## Tables

|Syntax                                 |Result                               |
|`*italic 1*`                           |*italic 1*                           |
|`_italic 2_`                           | _italic 2_                          |
|`**bold 1**`                           |**bold 1**                           |
|`__bold 2__`                           |__bold 2__                           |
|`This is a ~~strikethrough~~`          |This is a ~~strikethrough~~          |
|`***italic bold 1***`                  |***italic bold 1***                  |
|`___italic bold 2___`                  |___italic bold 2___                  |
|`***~~italic bold strikethrough 1~~***`|***~~italic bold strikethrough 1~~***|
|`~~***italic bold strikethrough 2***~~`|~~***italic bold strikethrough 2***~~|

## Styling
Style text as _italic_, __bold__, ~~strikethrough~~, or `inline code`.

- Use bulleted lists
- To better clarify
- Your points

## Code blocks
Formatted Dart code looks really pretty too:

void main() {
    home: Scaffold(
      body: Markdown(data: markdownData),

## Markdown widget

This is an example of how to create your own Markdown widget:

    Markdown(data: 'Hello _world_!');


[Google]: https://www.google.com/

void main() {
  final controller = ScrollController();

      title: "Markdown Demo",
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Markdown Demo'),
        body: SafeArea(
          child: Markdown(
            controller: controller,
            selectable: true,
            data: _markdownData,
            imageDirectory: 'https://raw.githubusercontent.com',
        floatingActionButton: FloatingActionButton(
          child: Icon(Icons.arrow_upward),
          onPressed: () => controller.animateTo(0,
              duration: Duration(seconds: 1), curve: Curves.easeOut),

Use this package as a library

1. Depend on it

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

  flutter_markdown: ^0.3.4

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';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Mar 31, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Health suggestions

Format lib/src/_functions_io.dart.

Run flutter format to format lib/src/_functions_io.dart.

Format lib/src/_functions_web.dart.

Run flutter format to format lib/src/_functions_web.dart.

Format lib/src/widget.dart.

Run flutter format to format lib/src/widget.dart.

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.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.5.0 <3.0.0
flutter 0.0.0
markdown ^2.1.3 2.1.3
meta ^1.1.7 1.1.8
path ^1.6.4 1.6.4
Transitive dependencies
args 1.6.0
charcode 1.1.3
collection 1.14.11 1.14.12
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
mockito ^3.0.0