How to Install MarkDownHelpViewer Delphi component

Installation of Delphi component

If you are a Delphi Developer you can use a component to integrate the help System "embedded" in you application.

Installation of Packages for Delphi (from XE6 to Delphi 13)

To Installa TMarkDownViewer component, you need to clone the sources from the Markdown Help Viewer Github Project

Open the correct group-project file for your Delphi version, located into Packages folder (for example: Packages\D13\MarkDownHelpViewerGroup.groupproj).

Then Build the run-time packages:

• FrameViewerXXX.bpl
• MarkDownViewerXXX.bpl

and Install the design-time package:

• dclMarkDownViewerXXX.bpl

The component TMarkdownViewer is ready to use.

Remember also to add those Search Path:

• {MarkdownViewerInstallDir}\Source
• {MarkdownViewerInstallDir}\Components
• {MarkdownViewerInstallDir}\AppInterface
• {MarkdownViewerInstallDir}\Ext\HTMLViewer\Source
• {MarkdownViewerInstallDir}\Ext\MarkdownProcessor\source

if you need package for other Delphi version not included (newer than XE6) please add a new Issue

Syntax Highlighting of Code Blocks

The TMarkDownViewer component shows fenced code blocks with syntax highlighting based on the language declared after the opening fence (for example ```delphi or ```json), like on GitHub. Many languages are recognized and the colors follow the theme (light or dark), derived from the viewer background.

Enabling or disabling the support (compile-time)

The syntax highlighting is controlled at compile time by the include file MD_SYNTAX_HIGHLIGHTING compiler directive.

• enabled (default): code blocks are colored. To produce the colors the component uses the SynEdit highlighters, so the SynEdit source is required and linked into your application. Add \Ext\SynEdit\Source to your search path.
• disabled: The component then does not reference SynEdit at all and code blocks are shown as plain monospace text. This is the right choice for a documentation-only viewer that never displays source code, so you don't carry the SynEdit dependency.

This switch affects only the code-block coloring: all the other features of the component work the same way in both modes.