SimpleMarkdown is an Android app for editing Markdown!
Find a file
2020-04-08 07:59:49 -07:00
app Convert AppComponent to Kotlin 2020-04-08 07:59:49 -07:00
gradle/wrapper Downgrade Android Gradle Plugin and Gradle Wrapper to stable versions 2020-04-08 07:58:56 -07:00
.gitignore Add basic readability highlighting 2020-04-08 07:59:36 -07:00
.gitlab-ci.yml Add basic readability highlighting 2020-04-08 07:59:36 -07:00
build.gradle Downgrade Android Gradle Plugin and Gradle Wrapper to stable versions 2020-04-08 07:58:56 -07:00
gradle.properties Migrate to AndroidX 2020-04-08 07:58:55 -07:00
gradlew Added gradle files and ignored Android Studio files 2017-07-25 18:20:36 -05:00
gradlew.bat Added gradle files and ignored Android Studio files 2017-07-25 18:20:36 -05:00
Jenkinsfile Fix jenkinsfile 2020-04-08 07:58:54 -07:00
keystore.properties.sample Fix jenkinsfile 2020-04-08 07:58:54 -07:00
LICENSE Added license and readme 2017-08-23 14:51:13 -05:00
NOTICE-ASL.txt Added some helpful information and licensing stuff 2017-08-23 21:17:50 -05:00
README.md Add basic readability highlighting 2020-04-08 07:59:36 -07:00
settings.gradle Remove Samsung and admob dependencies 2020-04-08 07:58:55 -07:00

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