https://github.com/luizlealdev/markdown-editor
A native android markdown editor that you can write your markdown code and visualise it.
https://github.com/luizlealdev/markdown-editor
android-app codeview kotlin-android markdown-editor markwon mvvm-android room-database
Last synced: 4 months ago
JSON representation
A native android markdown editor that you can write your markdown code and visualise it.
- Host: GitHub
- URL: https://github.com/luizlealdev/markdown-editor
- Owner: luizlealdev
- License: apache-2.0
- Created: 2024-07-12T13:52:04.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-27T12:14:48.000Z (over 1 year ago)
- Last Synced: 2025-04-10T01:44:55.891Z (10 months ago)
- Topics: android-app, codeview, kotlin-android, markdown-editor, markwon, mvvm-android, room-database
- Language: Kotlin
- Homepage:
- Size: 9.11 MB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markdown Editor
Markdown Editor demonstrates a simple editor that converts your markdown code and visualize it.
## 📥 Download
## 📷 Previews
## 🛠 Tech Stack & Open Source Libraries
- Minimum SDK level 24.
- [Kotlin language](https://kotlinlang.org/)
- Jetpack
- ViewBinding: Connect the components from the XML in Kotlin through a class that ensures type safety and other advantages.
- Lifecycle: Observe Android lifecycles and handle user interface states after lifecycle changes.
- Room Database: Database abstraction library for SQLite that ensures compile-time safety and ease of use.
- ViewModel: Manages the holder of data related to the user interface and the lifecycle. Allows data to survive configuration changes, such as screen rotations.
- Architecture
- MVVM (View - ViewModel - Model)
- Communication between ViewModel and View through LiveData
- Communication between ViewModel and Model through Kotlin Flow
- Repositories for abstraction of communication with the data layer.
- Libraries
- [OkHttp3](https://github.com/square/retrofit): For making requests following the HTTP standard.
- [Markwon](https://github.com/noties/Markwon): For process the markdown code.
- [Fab SpeedDial](https://github.com/leinardi/FloatingActionButtonSpeedDial): For add a Floating Action Button Speed Dial implementation.
- [CodeView](https://github.com/amrdeveloper/codeview): For add add syntax highlight and line numbers into a EditText.
## 📐 Architecture
**Markdown Editor** follows the [Google's official architecture](https://developer.android.com/topic/architecture).
## ✨ Features
| Feature 1 | Feature 2 |
|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| Search markdown note | Import markdown from file |
| 
| 
|
| Feature 3 | Feature 4 |
|----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| Import markdown from URL | Markdown tips bar |
| 
| 
|
## 📄 License
```
Copyright 2024 Luiz Leal
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.
```