flutter_markdown 0.1.1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 97

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.

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

1. Depend on it

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


dependencies:
  flutter_markdown: "^0.1.1"

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support 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.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

Analysis

This feature is new.
We welcome feedback.
More details: scoring.

We analyzed this package, and provided a score, details, and suggestions below.

  • completed on Feb 3, 2018
  • Dart: 2.0.0-dev.20.0
  • pana: 0.10.1
  • Flutter: 0.0.22

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
94 / 100
Health:
Code health derived from static analysis. [more]
99 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100 / 100
Overall score:
Weighted score of the above. [more]
97

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Suggestions

  • The description is too short.

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

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Maintain an example.

    None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use flutter_markdown.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.19.0 <2.0.0
flutter 0.0.0
markdown ^1.0.0 1.1.1
meta ^1.0.5 1.1.1 1.1.2
string_scanner ^1.0.0 1.0.2
Transitive dependencies
async 2.0.3
charcode 1.1.1
collection 1.14.5
http 0.11.3+16
http_parser 3.1.1
path 1.5.1
sky_engine 0.0.99
source_span 1.4.0
typed_data 1.1.4 1.1.5
vector_math 2.0.5
Dev dependencies
flutter_test