wbrawner/SimpleMarkdown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
SimpleMarkdown is an Android app for editing Markdown!
93 commits 6 branches 27 tags 3.9 MiB
Kotlin 99.9%
Shell 0.1%
Find a file
Billy Brawner decb4d76ff Bump version number
2020-04-08 07:58:54 -07:00
app Bump version number 2020-04-08 07:58:54 -07:00
gradle/wrapper Update gradle wrapper and dependencies 2020-04-08 07:58:54 -07:00
IAP5Helper Update gradle wrapper and dependencies 2020-04-08 07:58:54 -07:00
.gitignore Replace ACRA with Firebase Crashlytics 2020-04-08 07:58:54 -07:00
build.gradle Update gradle wrapper and dependencies 2020-04-08 07:58:54 -07:00
gradle.properties Added gradle files and ignored Android Studio files 2017-07-25 18:20:36 -05: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 Add 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 Replace ACRA with Firebase Crashlytics 2020-04-08 07:58:54 -07:00
settings.gradle Add Samsung build flavor 2020-04-08 07:58:53 -07:00

README.md

Simple Markdown

Build Status

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)
  • Disable live preview in landscape mode
  • Disable preview tab for better performance in large files
  • Custom CSS for Markdown preview
  • Auto-scroll preview to match edit view in landscape mode
  • Better insert for tables/images/links
  • Quick-insert toolbar for common Markdown syntax characters

Building

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

./gradlew assembleDebug

Firebase

SimpleMarkdown makes use of Firebase for crash reports. To integrate with your own project, create a project from the Firebase Console and enable Crashlytics support. Download the google-services.json file and place it in the app/ directory. Additionally, you'll need another google-services.json file enabled for the app.package.name.samsung version of the app, placed in the app/src/samsung/ directory.

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 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