Skip to content

Commit 75f6bf9

Browse files
authored
Update README.md
Moved readme information to the wiki
1 parent b5abeef commit 75f6bf9

File tree

1 file changed

+11
-116
lines changed

1 file changed

+11
-116
lines changed

README.md

Lines changed: 11 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -4,124 +4,17 @@
44

55
**A collection of tools for markdown files, to edit and view content:**
66

7-
- A **Markdown Text Editor**[2] to manually edit a markdown file, with instant preview of the output in a HTML Viewer.
7+
- A **Markdown Text Editor** to manually edit a markdown file, with instant preview of the output in a HTML Viewer.
88

9-
- A **Preview handler**[1] which allows you to see the content of the markdown file without open it, in the "Preview Panel", integrated into Windows Explorer.
10-
11-
### Features
12-
13-
- No need to built the project with Delphi: an easy Setup is provided.
14-
15-
- Supports Windows Vista, 7, 8, 10 and 11 (for 32 bits and 64 bits).
16-
17-
- Themes (Dark and Light) according to user preferences of Windows Theme
18-
19-
- Integrated also with other Shell Applications (like XYplorer)
20-
21-
### Delphi: integration with MarkDown Help Viewer
22-
23-
- 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.
24-
- Use the **Markdown Text Editor** to edit your help files and use the **Markdown Help Viewer** to show them.
25-
26-
### Setup using the Installer
27-
28-
Click to download the [MDShellExtensionsSetup.exe][3] located also in the Release area. The Installer works both for 32 and 64 bit system.
29-
30-
![Markdown Setup_Program](./Images/Setup.png)
31-
32-
***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).***
33-
34-
### Preview Panel in action ###
35-
36-
In Windows 10 with Dark theme:
37-
38-
![Preview Panel Dark](./Images/PreviewPanelDark.png)
39-
40-
### Markdown Text Editor
41-
42-
A useful Text editor with instant preview of Markdown formatted content:
43-
44-
![Markdown Text Editor Dark](./Images/MDTextEditorLight.png)
45-
46-
### Manual Build and Installation (only for Delphi developers) ###
47-
48-
If you have Delphi 10.4 Sydney or 11.3 Alexandria, you can manually build the project:
49-
50-
***Warning: To simplyfy build of the projects, some third parties libraries are located into ext folder***
51-
52-
To manually install the SVGShellExtensions.dll follow these steps:
53-
54-
1. 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).
55-
56-
2. If you have already used the installer uninstall the components from system.
57-
58-
3. To install manually the dll run the `Unregister_Register.cmd` (run-as-administrator): notice that you must change the path into cmd file.
59-
60-
## Release Notes ##
61-
62-
22 Oct 2023: ver. 2.0.0
63-
- Added use of Skia4Delphi
64-
- Added support for new image format (webp and wbmp)
65-
- Uses AnimatedStyledDialogs for messages
66-
- Added toolbar for markdown commands
67-
- Added dialog for input of hyperlink for Images and Files
68-
- Updated Markdown library with best support for CommonMark transformation
69-
70-
1. Subscript <sub>text</sub> and Superscript <sup>text</sup>
71-
1. Formulas (using [Google Chart API])
72-
1. ==Markers==
73-
1. [Reference-style Links][1]
74-
75-
29 Jun 2023: ver. 1.5.2
76-
- Fixed loading images with "spaces" in the filename
77-
- Fixed immediate-loading of new images when editing the file
78-
- During loading of remote images, user can stop loading pressing "Esc"
79-
- Updated Copyright for the Editor
80-
81-
26 Jun 2023: ver. 1.5.1
82-
- Fixed Preview of Markdown files with extensions different from .markdown
83-
84-
24 Jun 2023: ver. 1.5.0
85-
- Autoload local markdown files when clicked into Preview
86-
- The editor can open all markdown extensions: .md, .mkd, .mdwn, .mdown, .mdtxt, .mdtext, .markdown, .txt, .text'
87-
- Stopped image rendering during editing to speed-up
88-
- Added useful close button on Tabs
89-
- Hint full filename on Tabs
90-
- Save/Discard messaged default response inverted
91-
- Removed Settings "Search In Folder"
92-
93-
1 Nov 2022: ver. 1.4.3
94-
- Fixed loading images into Preview
95-
- Fixed the setting for local loading
96-
97-
11 Set 2022: ver. 1.4.1
98-
- Added Combobox for easy selection Markdown Dialect
99-
- Added Windows 11 light and dark styles
100-
- Fixed load file with blanks in content menu
101-
- Fixed loading ANSI files
102-
- Fixed AV in Settings with opened files
103-
104-
20 Jan 2022: ver. 1.3.0
105-
- Added Support for Windows 11
106-
- Fixed resize content
107-
108-
04 Sep 2021: ver. 1.2.0
109-
- Added Support for Delphi 11
110-
- Updated Image32 Lib
111-
112-
20 Jul 2021: ver. 1.1.0
113-
- Added Image32 Lib to best rendering of SVG Images
114-
115-
06 Jul 2021
116-
- First public release with setup
9+
- 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.
11710

11811
## Credits
11912

120-
Many thanks to **Rodrigo Ruz V.** (author of [theroadtodelphi.com][7] Blog) for his wonderful work on [delphi-preview-handler][8] from which this project has used a lot of code and inspiration.
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.
12114

12215
## License
12316

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

12619
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.
12720

@@ -200,15 +93,17 @@ Copyright (c) 2009 - 2023 by HtmlViewer Team
20093

20194
![Delphi Support](/Setup/SupportingDelphi.jpg)
20295

203-
Related links: [embarcadero.com][3] - [learndelphi.org][4]
96+
Related links: [embarcadero.com][2] - [learndelphi.org][3]
97+
98+
[1]: https://opensource.org/licenses/Apache-2.0
20499

205-
[1]: https://github.com/EtheaDev/MarkdownHelpViewer/releases/latest/download/MarkDownHelpViewerSetup.exe
100+
[2]: https://www.embarcadero.com/
206101

207-
[2]: https://opensource.org/licenses/Apache-2.0
102+
[3]: https://learndelphi.org/
208103

209-
[3]: https://www.embarcadero.com/
104+
[4]: https://theroadtodelphi.com/
210105

211-
[4]: https://learndelphi.org/
106+
[5]: https://theroadtodelphi.com/category/previewhandler/
212107

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

0 commit comments

Comments
 (0)