Skip to content

Commit ce5fbe9

Browse files
authored
Update README.md
1 parent 75f6bf9 commit ce5fbe9

File tree

1 file changed

+109
-11
lines changed

1 file changed

+109
-11
lines changed

README.md

Lines changed: 109 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# Markdown Editor and Shell Extensions [![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://opensource.org/licenses/Apache-2.0)
2-
1+
# Markdown Editor and Shell Extensions [![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://opensource.org/licenses/Apache-2.0)
32
**Latest Version 2.0.0 - 22 Oct 2023**
43

54
**A collection of tools for markdown files, to edit and view content:**
@@ -8,13 +7,110 @@
87

98
- A **Preview handler** which allows you to see the content of the markdown file without open it, in the "Preview Panel", integrated into Windows Explorer.
109

10+
### Features
11+
12+
- No need to built the project with Delphi: an easy Setup is provided.
13+
14+
- Supports Windows Vista, 7, 8, 10 and 11 (for 32 bits and 64 bits).
15+
16+
- Themes (Dark and Light) according to user preferences of Windows Theme
17+
18+
- Integrated also with other Shell Applications (like XYplorer)
19+
20+
### Delphi: integration with MarkDown Help Viewer
21+
22+
- For Delphi developers: use this tool to prepare and integrate a Help System in your application, using the ["MarkDown Help Viewer"](https://github.com/EtheaDev/MarkdownHelpViewer) project.
23+
- Use the **Markdown Text Editor** to edit your help files and use the **Markdown Help Viewer** to show them.
24+
25+
### Setup using the Installer
26+
27+
Click to download the [MDShellExtensionsSetup.exe][1] located also in the Release area. The Installer works both for 32 and 64 bit system.
28+
29+
![Markdown Setup_Program](./Images/Setup.png)
30+
31+
***For a clean Setup close all the windows explorer instances which have the preview handler active or the preview handler was used (remember the dll remains in memory until the windows explorer was closed).***
32+
33+
### Preview Panel in action ###
34+
35+
In Windows 10 with Dark theme:
36+
37+
![Preview Panel Dark](./Images/PreviewPanelDark.png)
38+
39+
### Markdown Text Editor
40+
41+
A useful Text editor with instant preview of Markdown formatted content:
42+
43+
![Markdown Text Editor Dark](./Images/MDTextEditorLight.png)
44+
45+
### Manual Build and Installation (only for Delphi developers) ###
46+
47+
Learn more about the manual within our [wiki](https://github.com/EtheaDev/MarkdownShellExtensions/wiki/Manual-Build-and-Installation). Dive deeper into everything related to this tool, its features, and how to make the most of it.
48+
49+
## Release Notes ##
50+
51+
22 Oct 2023: ver. 2.0.0
52+
- Added use of Skia4Delphi
53+
- Added support for new image format (webp and wbmp)
54+
- Uses AnimatedStyledDialogs for messages
55+
- Added toolbar for markdown commands
56+
- Added dialog for input of hyperlink for Images and Files
57+
- Updated Markdown library with best support for CommonMark transformation
58+
59+
1. Subscript <sub>text</sub> and Superscript <sup>text</sup>
60+
1. Formulas (using [Google Chart API])
61+
1. ==Markers==
62+
1. [Reference-style Links]
63+
64+
29 Jun 2023: ver. 1.5.2
65+
- Fixed loading images with "spaces" in the filename
66+
- Fixed immediate-loading of new images when editing the file
67+
- During loading of remote images, user can stop loading pressing "Esc"
68+
- Updated Copyright for the Editor
69+
70+
26 Jun 2023: ver. 1.5.1
71+
- Fixed Preview of Markdown files with extensions different from .markdown
72+
73+
24 Jun 2023: ver. 1.5.0
74+
- Autoload local markdown files when clicked into Preview
75+
- The editor can open all markdown extensions: .md, .mkd, .mdwn, .mdown, .mdtxt, .mdtext, .markdown, .txt, .text'
76+
- Stopped image rendering during editing to speed-up
77+
- Added useful close button on Tabs
78+
- Hint full filename on Tabs
79+
- Save/Discard messaged default response inverted
80+
- Removed Settings "Search In Folder"
81+
82+
1 Nov 2022: ver. 1.4.3
83+
- Fixed loading images into Preview
84+
- Fixed the setting for local loading
85+
86+
11 Set 2022: ver. 1.4.1
87+
- Added Combobox for easy selection Markdown Dialect
88+
- Added Windows 11 light and dark styles
89+
- Fixed load file with blanks in content menu
90+
- Fixed loading ANSI files
91+
- Fixed AV in Settings with opened files
92+
93+
20 Jan 2022: ver. 1.3.0
94+
- Added Support for Windows 11
95+
- Fixed resize content
96+
97+
04 Sep 2021: ver. 1.2.0
98+
- Added Support for Delphi 11
99+
- Updated Image32 Lib
100+
101+
20 Jul 2021: ver. 1.1.0
102+
- Added Image32 Lib to best rendering of SVG Images
103+
104+
06 Jul 2021
105+
- First public release with setup
106+
11107
## Credits
12108

13-
Many thanks to **Rodrigo Ruz V.** (author of [theroadtodelphi.com][4] Blog) for his wonderful work on [delphi-preview-handler][5] from which this project has used a lot of code and inspiration.
109+
Many thanks to **Rodrigo Ruz V.** (author of [theroadtodelphi.com][5] Blog) for his wonderful work on [delphi-preview-handler][6] from which this project has used a lot of code and inspiration.
14110

15111
## License
16112

17-
Licensed under the [Apache License, Version 2.0][1] (the "License");
113+
Licensed under the [Apache License, Version 2.0][2] (the "License");
18114

19115
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.
20116

@@ -93,18 +189,20 @@ Copyright (c) 2009 - 2023 by HtmlViewer Team
93189

94190
![Delphi Support](/Setup/SupportingDelphi.jpg)
95191

96-
Related links: [embarcadero.com][2] - [learndelphi.org][3]
192+
Related links: [embarcadero.com][3] - [learndelphi.org][4]
193+
194+
[1]: https://github.com/EtheaDev/MarkdownShellExtensions/releases/latest/download/MDShellExtensionsSetup.exe
97195

98-
[1]: https://opensource.org/licenses/Apache-2.0
196+
[2]: https://opensource.org/licenses/Apache-2.0
99197

100-
[2]: https://www.embarcadero.com/
198+
[3]: https://www.embarcadero.com/
101199

102-
[3]: https://learndelphi.org/
200+
[4]: https://learndelphi.org/
103201

104-
[4]: https://theroadtodelphi.com/
202+
[5]: https://theroadtodelphi.com/
105203

106-
[5]: https://theroadtodelphi.com/category/previewhandler/
204+
[6]: https://theroadtodelphi.com/category/previewhandler/
107205

108206
[Google Chart API]: https://developers.google.com/chart/infographics/docs/formulas
109207

110-
[Reference-style-Links]: https://www.markdownguide.org/basic-syntax/#reference-style-links
208+
[Reference-style Links]: https://www.markdownguide.org/basic-syntax/#reference-style-links

0 commit comments

Comments
 (0)