Markdown2HTML

(Hide table-of-contents)

Markdown2HTML is part of the CategoryAplTree project.

Overview

Markdown2HTML is an application designed to help converting a Markdown file into HTML by using the MarkAPL class.

It can be used in three different ways:

Usage as a Windows GUI application

By double-clicking the EXE file one can start the application as a Windows GUI application.

This is how the GUI looks like:

Markdown2HTML_1.png

In this example Markdown2HTML's own README.HTML was drag- and dropped onto the left pane of the GUI; then the "Process file" button was clicked. As a result the HTML is shown on the right pane in the "Preview" tab. At the same time the newly created HTML file is saved as a sibling of the input file, sharing the same name but with the extension "HTML".

Markdown2HTML can create either HTML snippets or full-blown HTML pages from the Markdown: see the "Produce full HTML document" check box on the top right corner of the left pane.

Instead of opening or dragging files you can also add Markdown straight into the application by entering it into the "Direct input" tab and then click the "Process" button.

Rather than previewing the resulting HTML you can also just look at the HTML via the "HTML" tab in the right pane. Because the - compressed - CSS can blur matters there is a "Hide CSS" check box available ot the bottom of that tab that allows you to exclude the CSS from view but not from the file of course.

Drag and drop

You can drag and drop one or more files onto the EXE. Any file extension but .htm and .html are accepted.

The application then converts the markdown to HTML and by default saves a new document with the same name but the file extension .html as a sibling of the input file. You can change this - see "Different output folder" for details.

Context menu

You can add a command "Convert to HTML5 with MarkAPL"; the file "readme.html" explains how to do this.

You can then right-click on any file with the extension .md or .markdown and select this command from the context menu.

The application then converts the Markdown to HTML and by default saves a new document with the same name but the file extension .html as a sibling of the input file. You can change this - see "Different output folder" for details.

Different output folder

If you want the HTML file not to be a sibling of the input file you can create a file .Markdown22HTML as a sibling of the input file. Specify a different output folder with something like

outputPath = 'c:\temp\myhtml'

or

outputPath = '..\myhtml'      

The latter is interpreted as relative to the input file.

Note that this file specifies the output folder for all markdown files in that folder.

MarkAPL parameter

Since MarkAPL supports embedded parameters you can actually set most of the MarkAPL parameters inside your Markdown document and tell MarkAPL that way what to do and what not to do.

Getting help with Markdown and MarkAPL

Both the MarkAPL reference as well as the MarkAPL cheat sheet are available from Markdown2HTML's help page - see there for details.

Requirements

Markdown2HTML comes as a stand-alone EXE. It does not require anything.

After having downloaded the ZIP file unzip the contents and read the "README.HTML" file and follow the instructions.

Project Page

For bug reports, future enhancements and a full version history see Markdown2HTML/ProjectPage

Version Information

Original author:

KaiJaeger

Responsible:

KaiJaeger

Email:

kai@aplteam.com

APLTree downloads

Using an APLTree member

  1. If you just want to consume (use) an APLTree member then you have several choices:
    • Note that accessing it via ftp allows you to download older versions as well while the dedicated download page offers just the most current version.

Contributing

If you want to contribute to an APLTree project see HowToContributeToTheAPLTreeProject for details.

Get the full project

If for some reason you need access to, say, the test cases then you need to get more then just the script (or application) itself.

HowToContributeToTheAPLTreeProject explains how to get a project onto your local machine. Just ignore any additional steps.

Create a new APLTree sub project

In order to create a new APLTree project you need some advice. Ask KaiJaeger for help: mailto:kai@aplteam.com


CategoryAplTree

Markdown2HTML (last edited 2017-01-07 12:55:35 by KaiJaeger)