flutter_markdown 0.2.0

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 94

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:

new Markdown(data: markdownSource);

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

new 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. It specifically does not support image locations referring to bundled assets.

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

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/example.dart

// 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.

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

- Use bulleted lists
- To better clarify
- Your points

## Links
You can use [hyperlinks](hyperlink) in markdown

## Images

You can include images:

![Flutter logo](https://flutter.io/images/flutter-mark-square-100.png#100x100)

## Markdown widget

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

    new Markdown(data: 'Hello _world_!');

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

```
void main() {
  runApp(new MaterialApp(
    home: new Scaffold(
      body: new Markdown(data: markdownData)
    )
  ));
}
```

Enjoy!
""";

void main() {
  runApp(new MaterialApp(
    title: "Markdown Demo",
    home: new Scaffold(
      appBar: new AppBar(title: const Text('Markdown Demo')),
      body: const Markdown(data: _markdownData)
    )
  ));
}

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_markdown: ^0.2.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages 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';
  
Version Uploaded Documentation Archive
0.2.0 Aug 21, 2018 Go to the documentation of flutter_markdown 0.2.0 Download flutter_markdown 0.2.0 archive
0.1.6 Aug 1, 2018 Go to the documentation of flutter_markdown 0.1.6 Download flutter_markdown 0.1.6 archive
0.1.5 Mar 28, 2018 Go to the documentation of flutter_markdown 0.1.5 Download flutter_markdown 0.1.5 archive
0.1.3 Feb 20, 2018 Go to the documentation of flutter_markdown 0.1.3 Download flutter_markdown 0.1.3 archive
0.1.2 Feb 20, 2018 Go to the documentation of flutter_markdown 0.1.2 Download flutter_markdown 0.1.2 archive
0.1.1 Dec 22, 2017 Go to the documentation of flutter_markdown 0.1.1 Download flutter_markdown 0.1.1 archive
0.1.0 Nov 7, 2017 Go to the documentation of flutter_markdown 0.1.0 Download flutter_markdown 0.1.0 archive
0.0.9 May 4, 2017 Go to the documentation of flutter_markdown 0.0.9 Download flutter_markdown 0.0.9 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
97
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]
94
Learn more about scoring.

We analyzed this package on Oct 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0
  • pana: 0.12.4
  • Flutter: 0.9.5

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/src/builder.dart.

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

Format lib/src/style_sheet.dart.

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

Format lib/src/widget.dart.

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

Maintenance suggestions

The description is too short. (-20 points)

Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.58.0 <3.0.0
flutter 0.0.0
markdown ^2.0.0 2.0.2
meta ^1.0.5 1.1.6
path ^1.5.1 1.6.2
string_scanner ^1.0.0 1.0.4
Transitive dependencies
args 1.5.0
charcode 1.1.2
collection 1.14.11
sky_engine 0.0.99
source_span 1.4.1
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test
mockito ^3.0.0