Skip to content

Commit 1abc19d

Browse files
author
ag88
committed
initial commit
0 parents  commit 1abc19d

File tree

28 files changed

+2597
-0
lines changed

28 files changed

+2597
-0
lines changed

‎.github/FUNDING.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
#patreon: # Replace with a single Patreon username
5+
#open_collective: # Replace with a single Open Collective username
6+
#ko_fi: # Replace with a single Ko-fi username
7+
#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
#liberapay: # Replace with a single Liberapay username
10+
#issuehunt: # Replace with a single IssueHunt username
11+
#otechie: # Replace with a single Otechie username
12+
custom: ["https://donorbox.org/jmdviewer"]

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
target

‎LICENSE.txt‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
- jmdviewer - this app
2+
3+
Copyright (c) 2021 Andrew Goh
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is furnished
10+
to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be
13+
included in all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
21+
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22+
23+
- commonmark java
24+
Copyright (c) 2015-2016, Atlassian Pty Ltd
25+
All rights reserved.
26+
27+
Redistribution and use in source and binary forms, with or without
28+
modification, are permitted provided that the following conditions are met:
29+
30+
* Redistributions of source code must retain the above copyright notice, this
31+
list of conditions and the following disclaimer.
32+
33+
* Redistributions in binary form must reproduce the above copyright notice,
34+
this list of conditions and the following disclaimer in the documentation
35+
and/or other materials provided with the distribution.
36+
37+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
38+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
39+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
41+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
42+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
43+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
44+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
46+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
47+
48+
github.css used in resources:
49+
/*
50+
Copyright (c) 2017 Chris Patuzzo
51+
https://twitter.com/chrispatuzzo
52+
53+
Permission is hereby granted, free of charge, to any person obtaining a copy
54+
of this software and associated documentation files (the "Software"), to deal
55+
in the Software without restriction, including without limitation the rights
56+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
57+
copies of the Software, and to permit persons to whom the Software is
58+
furnished to do so, subject to the following conditions:
59+
60+
The above copyright notice and this permission notice shall be included in all
61+
copies or substantial portions of the Software.
62+
63+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
64+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
65+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
66+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
67+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
68+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
69+
SOFTWARE.
70+
*/
71+

‎README.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# ![Markdown](web/markdown.png "Markdown")   Markdown Viewer
2+
---
3+
4+
This is a Markdown viewer for java. Primarily it tries to display github styled markdown scripts.
5+
6+
7+
![example](web/screen.png "example")
8+
9+
## Run
10+
11+
Download the release jar file and run
12+
```
13+
java -jar jmdviewer-x.y.jar
14+
```
15+
where x.y is the version number. You can pass the markdown filename on the command line
16+
```
17+
java -jar jmdviewer-x.y.jar [filename.md]
18+
```
19+
## Build
20+
21+
In linux/osx/un*x:
22+
```
23+
mvnw clean package
24+
```
25+
in windows:
26+
```
27+
mvnw.cmd clean package
28+
```
29+
The built jar file is in the target folder.
30+
31+
## Pre-requisites
32+
33+
Java >= 1.8
34+
35+
## Notes / limitations
36+
37+
- Rendering of images and other html features is based on available features in Java
38+
Swing. This generally support formats such as jpg, png and gif. Unsupported image formats would be rendered with a broken image icon.
39+
40+
## Attributions
41+
42+
- Markdown parser: Commonmark java
43+
[https://github.com/commonmark/commonmark-java](https://github.com/commonmark/commonmark-java)
44+
45+
46+
## License
47+
48+
This application is licensed under MIT license:
49+
Copyright (c) 2021 Andrew Goh
50+
51+
Various sub-license for Commonmark-java and resources used is
52+
appended in LICENSE.txt
53+
54+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
55+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
56+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
57+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
58+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
59+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
60+
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
61+
62+
## Origin
63+
64+
github repository:
65+
[https://github.com/ag88/jmdviewer](https://github.com/ag88/jmdviewer)
66+
67+
Developing this has taken quite some effort mainly in getting it to work and rather extensive tests. if you use this app and found it useful, i'd really appreciate it if you could support my efforts [![Donate](web/donorbox.png)](https://donorbox.org/jmdviewer) ;)

0 commit comments

Comments
 (0)