SimpleMarkdown/README.md
Billy Brawner c2e6837fb4 Add basic readability highlighting
Personally, I'm a terrible writer and I've found simple aids really help keep my prose tight.
These changes will highlight sentences that are hard to read, based on the number of syllables they contain.
Here's what happens based on syllable count:
- less than 25 syllables: its easy to read (heuristically speaking), and has no background colour
- between 25 and 35 syllables, it's a bit hard to understand, and has a yellow background colour
- over 35 syllables, its quite hard to read, and has a red background color

This might be well outside the scope of what you had in mind, but I personally find it usefull.
At the moment it's on by default, in a seperate observer.
Maybe you could add add a setting for it
2019-08-02 03:00:29 +00:00

2.5 KiB

Simple Markdown

pipeline status coverage report

Simple Markdown is simply a Markdown editor :) I wrote it to offer up an open source alternative to the other Markdown editors available on the Play Store. I also wanted to get some practice in creating Android apps and have a little something to put into my portfolio.

Roadmap

  • Auto-save
  • Night mode
  • Save to cloud (Dropbox, Google Drive, OneDrive)
  • Custom CSS for Markdown preview
  • Better insert for tables/images/links
  • Quick-insert toolbar for common Markdown syntax characters
  • Auto-scroll preview to match edit view in landscape mode
  • Disable live preview in landscape mode
  • Disable preview tab for better performance in large files

Building

Using Android Studio is the preferred way to build the project. To build from the command line, you can run

./gradlew assembleDebug

Crashlytics

SimpleMarkdown makes use of Firebase Crashlytics for error reporting. You'll need to follow the Get started with Firebase Crashlytics guide in order to build the project.

Contributing

I'd love any contributions, particularly in improving the existing code. Please just fork the repository, make your changes, squash your commits, and submit a pull request :)

License

   Copyright 2017-2019 William Brawner

   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.

Libraries