EtheaDev / MarkdownShellExtensions

A Markdown Text Editor to manually edit a markdown file, with instant preview of the output in a HTML Viewer. 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.
Apache License 2.0
63 stars 15 forks source link

# Markdown Editor and Shell Extensions License

Latest Version 2.3.1 - 15 Sep 2024

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

Features

Delphi: integration with MarkDown Help Viewer

Setup using the Installer

Click to download the MDShellExtensionsSetup.exe located also in the Release area. The Installer works both for 32 and 64 bit system.

Markdown Setup_Program

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).

Markdown Text Editor

A useful Text editor with instant preview of Markdown formatted content:

Markdown Text Editor Dark

Manual Build and Installation (only for Delphi developers)

Learn more about the manual within our wiki. Dive deeper into everything related to this tool, its features, and how to make the most of it.

Preview Panel in action

In Windows 10 with Dark theme:

Preview Panel Dark

Manual Build and Installation (only for Delphi developers)

If you have Delphi 12, you can manually build the projects using:

\Source\MDShellExtensionsGroup.groupproj

or the command: Build.bat (defining location of your Delphi environment)

Warning: To simplyfy build of the projects, some third parties libraries are located into ext folder

To manually install the SVGShellExtensions.dll follow these steps:

  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).

  2. If you have already used the installer uninstall the components from system.

  3. To install manually the dll run the Unregister_Register.cmd (run-as-administrator): notice that you must change the path into cmd file.

Release Notes

15 Sep 2024: ver. 2.3.1

28 Aug 2024: ver. 2.3.0

28 May 2024: ver. 2.2.5

23 May 2024: ver. 2.2.4

21 May 2024: ver. 2.2.3

10 May 2024: ver. 2.2.2

09 May 2024: ver. 2.2.1

20 Mar 2024: ver. 2.2.0

13 Jan 2024: ver. 2.1.0

3 Nov 2023: ver. 2.0.2

25 Oct 2023: ver. 2.0.1

24 Oct 2023: ver. 2.0.0

  1. Subscript text and Superscript text
  2. Formulas (using Google Chart API)
  3. ==Markers==
  4. Reference-style Links

29 Jun 2023: ver. 1.5.2

26 Jun 2023: ver. 1.5.1

24 Jun 2023: ver. 1.5.0

1 Nov 2022: ver. 1.4.3

11 Set 2022: ver. 1.4.1

20 Jan 2022: ver. 1.3.0

04 Sep 2021: ver. 1.2.0

20 Jul 2021: ver. 1.1.0

06 Jul 2021

Credits

Many thanks to Rodrigo Ruz V. (author of theroadtodelphi.com Blog) for his wonderful work on delphi-preview-handler from which this project has used a lot of code and inspiration.

License

Licensed under the Apache License, Version 2.0 (the "License");

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.

Other libraries from Ethea:

SVGIconImageList - https://github.com/EtheaDev/SVGIconImageList/

StyledComponents - https://github.com/EtheaDev/StyledComponents

Delphi MarkdownProcessor - https://github.com/EtheaDev/MarkdownProcessor

Third parties libraries:

OpenSLL Library: Cryptography and SSL/TLS Toolkit

Copyright © 1998-2018 The OpenSSL Project. All rights reserved.

Delphi Markdown - https://github.com/grahamegrieve/delphi-markdown

Copyright (c) 2011+, Health Intersections Pty Ltd All rights reserved

Delphi Preview Handler - https://github.com/RRUZ/delphi-preview-handler

The Initial Developer of the Original Code is Rodrigo Ruz V. Portions created by Rodrigo Ruz V. are Copyright © 2011-2023 Rodrigo Ruz V.

SynEdit - http://synedit.svn.sourceforge.net/viewvc/synedit/

all rights reserved.

Synopse/SynPDF - https://github.com/synopse/SynPDF

Copyright © Synopse: all right reserved.

HtmlToPdf - https://github.com/MuzioValerio/HtmlToPdf

Copyright © Muzio Valerio.

Image32 Library - http://www.angusj.com/delphi/image32/Docs/_Body.htm

Copyright ©2019-2023 Angus Johnson.

dzlib - https://sourceforge.net/projects/dzlib/

Copyright (c) Thomas Mueller

HTMLViewer - https://github.com/BerndGabriel/HtmlViewer

Copyright (c) 1995 - 2008 by L. David Baldwin

Copyright (c) 1995 - 2023 by Anders Melander (DitherUnit.pas)

Copyright (c) 1995 - 2023 by Ron Collins (HtmlGif1.pas)

Copyright (c) 2008 - 2009 by Sebastian Zierer (Delphi 2009 Port)

Copyright (c) 2008 - 2010 by Arvid Winkelsdorf (Fixes)

Copyright (c) 2009 - 2023 by HtmlViewer Team

External projects

To simpilfy compilation of projects they are added into ext folder

SVGIconImageList

HtmlViewer

vcl-styles-utils

markdownProcessor

StyledComponents

dzlib

Delphi Support

Related links: embarcadero.com - learndelphi.org