Skip to content

Latest commit

 

History

History
93 lines (68 loc) · 2.92 KB

README.md

File metadata and controls

93 lines (68 loc) · 2.92 KB
Raw

Markdown Editor (markdown_editor)

⚠️ Warning, this library is still in development, there are frequent improvements and code changes approaching the first release and milestone. It is recommended to wait for the first release before using in a production application.

Main

Flutter library that contains widgets for editing markdown.

Features

  • Editor toolbar with Markdown basic functions.
  • Full editor widget with a toolbar.

Thumbnail

Getting started

Import the package using Flutter Pub:

flutter pub add markdown_editor

Usage

Editor

The editor is available as a single widget like so:

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text("Edit"),
      ),
      floatingActionButton: FloatingActionButton(
        child: const Icon(Icons.save),
        onPressed: () {
          // Save text here...
        },
      ),
      body: MarkdownEditorWidget(
        constantFocus: true,
      ),
    );
  }

Additional information

Contributing

In order to contribute to the repo, file any issues through GitHub or create a fork, and then a pull request in order to request new features be added in. Depending on if the pull request contains desired changes, the pull request may be accepted or denied. If unsure, please file an issue about it.

Planned Features

The following features are planned to be added in due time:

  • Unit tests to make sure features work as intended.
  • Add multi-line editing.
  • Numbered list support.
  • Bold, Italic, Underline, Strike-through
  • Horizontal rule

The following items maybe added in the future, however, are not being worked on:

  • UI tests to make sure UI works as intended.
  • Fancy-view: Inserted markers in text view appear to preview them.
  • Fancy-view: Images appear underneath image declaration in text.
  • Hide Markdown Mode
  • Hide Markdown Mode: Inline image view
  • Extendable editor engine interface: Add the ability to endlessly customize the editor as required. This includes, easily extendable custom toolbar actions, Hide Markdown Mode custom rendering, and Fancy-view custom rendering.