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

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

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/grahamegrieve/delphi-markdown
• Owner: grahamegrieve
• License: apache-2.0
• Created: 2015-12-28T00:21:04.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-06-01T01:28:33.000Z (about 1 year ago)
• Last Synced: 2024-01-09T01:14:57.156Z (5 months ago)
• Language: Pascal
• Size: 858 KB
• Stars: 183
• Watchers: 45
• Forks: 56
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-pascal - Markdown Processor for Pascal

README

        
# delphi-markdown

Markdown Processor for Pascal (Delphi/FPC)

## Basic Information

This is a Pascal library that processes to markdown to HTML.

At present the following dialects of markdown are supported:

* The Daring Fireball dialect (see https://daringfireball.net/projects/markdown/) (translated from https://github.com/rjeschke/txtmark)

* The CommonMark Specification (see https://spec.commonmark.org/0.28) (not quite complete. Stil to do: link references)

* Github Flavored Markdown

## Using the Library

Create a TMarkdownProcessor (MarkdownProcessor.pas) of the dialect you want:

     var

       md : TMarkdownProcessor;

       html : string;

     begin

       md := TMarkdownProcessor.createDialect(mdDaringFireball)

  

Decide whether you want to allow active content (not supported for CommonMark)

       md.UnSafe := true;

  

Note: you should only set this to true if you *need* to - active content can be a signficant safety/security issue.  

 

Generate HTML from the Markdown content:

       html := md.process(markdown); 

  

Note that the HTML returned is an HTML fragment, not a full HTML page.

## Testing

Internally, the library includes a comprehensive set of unit tests. For CommonMark,

the tests are those provided as part of the CommonMark spec.

## Delphi 

Versions Supported:

* Any unicode version of Delphi

To use the code:

* clone the repository, and use the units in \source 

To run the tests:

* Test Program is markdown\delphi\MarkDownTests.dproj

* you also need FastMM4, and DUnitX (and update the search paths)

* you'll have to update the run parameters to set the current directory to the root directory for your clones of the reop

* if you don't have TestInsight installed (you very much should!) you'll have to remove the TESTINSIGHT define in the project options

## FPC

Versions Supported:

* tested with FPC 3.2.0+ (but no particular reason it shouldn't work with earlier versions)

* tested with win32, win64, linux64, OSX (but no reason it shouldn't work on other platforms)

To use the code:

* clone the repository, and compile the MarkdownEngine package in source

* alternatively, you can use the units in \source directly

To run the tests:

* Test Program is markdown/fpc/MarkdownTestProgram.lpi

* you need to provide command line parameter -mdRoot [x] where [x] is the location of the repo on your local drive

* depends on https://github.com/grahamegrieve/lazarus-ide-tester

## License

Copyright (c) 2011+, Health Intersections Pty Ltd (http://www.healthintersections.com.au)

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,

are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice, this

   list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright notice,

   this list of conditions and the following disclaimer in the documentation

   and/or other materials provided with the distribution.

 * Neither the name of HL7 nor the names of its contributors may be used to

   endorse or promote products derived from this software without specific

   prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND

ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,

INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.