saket / wysiwyg

Work in progress

A markdown editor that highlights syntax in real-time.

TODO: upload to maven

Usage

val parser = FlexmarkMarkdownParser(MarkdownHintStyles(context), MarkdownSpanPool())
val markdownHints = MarkdownHints(editText, parser)
editText.addTextChangedListener(markdownHints.textWatcher())

Supported syntax

• Bold
• Italic
• Strikethrough
• Headings
• Quote
• Horizontal rule
• Lists
• Links

How do I...

Customize colors and dimensions?

MarkdownHintStyles contains default values for colors and dimensions that I felt were sensible. You can override them to change the feel of your editor. It's a Kotlin data class so overriding default values with Java may not be pretty.

Use a different markdown parser?

TODO

Extend support for more markdown syntax?

TODO

Use custom spans?

TODO

License

Copyright 2019 Saket Narayan.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

wysiwyg's Issues

Toggle markdown syntax visibility

It would be great if the API enabled the option to let user toggle if they want the markdown syntax to be visible or not and still keep the formatting.

Creating new extension for Parser to use '~' for both StrikeThrough and Underline

I have noticed there is no underline syntax available. So I have created a new extension and replaced StrikethroughExtension in FlexmarkMarkdownParser.

This will allow us to use "~~" for StrikeThrough and "~" for Underlines.

Should I create a PR for this?

Multiple kotlin versions for gradle plugin

Hello,

Any reason as to why you are using multiple kotlin version (1.3.10 & 1.3.21) in root gradle file?

https://github.com/saket/WYSIWYG/blob/2788abf7e70fcc5f1ee0b024100505ca525a11be/build.gradle#L24-L25

Occasional crashes when long pressing backpress/delete

Hello,

I cannot reproduce the issue every time, but occasionally app would crash when I long press the backpress/delete button.

Here is the crashlog:

java.lang.IndexOutOfBoundsException: setSpan (25 ... 36) ends beyond length 35
    at android.text.SpannableStringBuilder.checkRange(SpannableStringBuilder.java:1325)
    at android.text.SpannableStringBuilder.setSpan(SpannableStringBuilder.java:684)
    at android.text.SpannableStringBuilder.setSpan(SpannableStringBuilder.java:676)
    at me.saket.markdownrenderer.MarkdownHintsSpanWriter.writeTo(MarkdownHintsSpanWriter.kt:20)
    at me.saket.markdownrenderer.MarkdownHints$textWatcher$1$1$1$1.invoke(MarkdownHints.kt:48)
    at me.saket.markdownrenderer.MarkdownHints$textWatcher$1$1$1$1.invoke(MarkdownHints.kt:18)
    at me.saket.markdownrenderer.util.ViewExtensionsKt.suspendTextWatcherAndRun(ViewExtensions.kt:8)
    at me.saket.markdownrenderer.MarkdownHints$textWatcher$1$1$1.run(MarkdownHints.kt:46)
    at android.os.Handler.handleCallback(Handler.java:873)
    at android.os.Handler.dispatchMessage(Handler.java:99)
    at android.os.Looper.loop(Looper.java:209)
    at android.app.ActivityThread.main(ActivityThread.java:7021)
    at java.lang.reflect.Method.invoke(Native Method)
    at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:486)
    at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:872)