https://github.com/lukeonuke/lmark
Lmark, open and edit markdown files easily and visually
https://github.com/lukeonuke/lmark
javafx-desktop-apps markdown markdown-editor markdown-to-html markdown-to-pdf mit-license
Last synced: 4 months ago
JSON representation
Lmark, open and edit markdown files easily and visually
- Host: GitHub
- URL: https://github.com/lukeonuke/lmark
- Owner: LukeOnuke
- License: mit
- Created: 2021-08-09T13:23:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-22T21:09:45.000Z (almost 3 years ago)
- Last Synced: 2025-01-14T18:37:31.906Z (5 months ago)
- Topics: javafx-desktop-apps, markdown, markdown-editor, markdown-to-html, markdown-to-pdf, mit-license
- Language: Java
- Homepage:
- Size: 181 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/LukeOnuke/lmark/actions/workflows/main.yml)  
# lmark
***Basicly a markdownnotepad with extra open sauce!*** Or in academic wording an that allows you to easly open, edit and export md files.
### Main features include
- Export markdownView to ***pdf*** and ***html***!
- System synchronisable dark / light mode
- Native integration *(open with, and more)*.
- Multiplatform support *(windows, linux, macos)*
- Open source and free
- Desktop built application, made with enterprise technologies.
- Supports all scripts (chirilic, latin, Arabic, Japanese).
### Planned stuff
- Tabs
- Being able to choose the css on export to pdf or markdownView
- More tools in the toolbar
# Screenshots
*ℹ Keep in mind there is more stuff than shown on the screenshots.*
### Dark mode
### Light mode
# Contributions
If you want to contribute to **lmark**, please do. Contributers are welcome. For build instructions go to [# Builds](#builds)
# Builds
You can find the newest builds in the [package all platforms action](https://github.com/LukeOnuke/lmark/actions/workflows/main.yml), although be ware they might not work as intended.
## Setting up the project
Preffered IDE is intelij IDEA but you could make it work on others
## Building the code yourself
1. **Git clone the repository**
```
git clone https://github.com/LukeOnuke/lmark.git
```
2. **Navigate to project root**
3. **Package with maven**
```
mvn package
```
4. *(Optional)* **Compile to native application**
```
jpackage --type app-image --name lmark-app-image /
--input C:\Users\lukak\Documents\GitHub\mdedit\target /
--main-jar lmark.jar --main-class com.lukeonuke.lmark.LMark /
--verbose --dest jpkg
```
# Licence & legal
This program uses [fonts awsome 6](https://fontawesome.com/)
```txt
MIT License
Copyright (c) 2022 Luka Kresoja
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```