APL Wiki|
Size: 4221
Comment: fixed name of Stack Overflow
|
Size: 4689
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 9: | Line 9: |
| With MarkAPL you can either use variables of files or any combination of the two to convert Markdown into HTML5. | With MarkAPL you can either use variables or files or any combination of the two to convert Markdown into HTML5. |
| Line 17: | Line 17: |
| Today Markdown is used by many of the big names on the web. Examples are Git, !SourceForge, !Stack Overflow and Trello. Many wikis allow Markdown at least optionally for input. | Today Markdown is used by many of the big names on the web. Examples are Git, !SourceForge, Stack Overflow and Trello. Many wikis allow Markdown at least optionally for input. |
| Line 49: | Line 49: |
| ||!LeanPub extensions || || || || X || | |
| Line 51: | Line 52: |
== Documentation == A [[http://download.aplteam.com/MarkAPL.html|full documentation]] is available as an HTML page generated from Markdown with MarkAPL, as you would expect. This document is comprehensive and is therefore quite long: more than 30 pages. There is also a [[http://download.aplteam.com/MarkAPL_CheatSheet.html|cheat sheet]] available for the impatient APLer. |
MarkAPL
MarkAPL is a converter that converts Markdown into valid HTML5. It is written in Dyalog.
Markdown aims to make the process of writing for the web much easier by improving readability and, as a consequence, maintainability.
This is an example on the Wikipedia comparing Markdown with HTML.
With MarkAPL you can either use variables or files or any combination of the two to convert Markdown into HTML5.
Note that the original design of Markdown has proven to be an excellent idea but too limited for widespread use. Therefore extensions were implemented. Over time two approaches have proven to be particularly successful: Markdown Extra and PanDoc.
For several years it seemed that the segmentation of the different implementations would be a problem, but over time the implementations got closer. There is also the CommonMark initiative which aims to standardize Markdown. MarkAPL tries to be compliant with Commonmark within reason.
MarkAPL aims to implement most concepts and also adds a couple of enhancements that might be useful, be it in general or just for APLers.
Today Markdown is used by many of the big names on the web. Examples are Git, SourceForge, Stack Overflow and Trello. Many wikis allow Markdown at least optionally for input.
The following table highlights the features supported in MarkAPL:
Name |
Standard |
Extra |
Pandoc |
MarkAPL |
Abbreviations |
|
|
X |
X |
Automated links |
X |
X |
X |
X |
Blockquotes |
X |
X |
X |
X |
Calling functions |
|
|
|
X |
Code blocks (indented) |
X |
X |
X |
|
Code blocks (fenced) |
|
X |
X |
X |
Definition lists |
X |
X |
X |
X |
Footnotes |
X |
X |
X |
X |
Headers |
X |
X |
X |
X |
HTML blocks |
X |
X |
X |
X |
HR |
X |
X |
X |
X |
Images |
X |
X |
X |
X |
Inline markup |
X |
X |
X |
X |
Line breaks (two spaces) |
X |
X |
X |
|
Line breaks (\) |
|
|
X |
X |
Line breaks (<<br>>) |
|
|
|
X |
Links |
X |
X |
X |
X |
Link references |
X |
X |
X |
X |
Lists |
X |
X |
X |
X |
"loose"/"tight" lists |
X |
X |
X |
|
Markdown inside HTML |
|
X |
X |
|
Paragraphs |
X |
X |
X |
X |
Tables |
X |
X |
X |
X |
Table of contents (TOC) |
|
|
X |
X |
Sub TOC |
|
|
|
X |
Smart typography |
|
|
X |
X |
Special attributes |
|
X |
X |
X |
LeanPub extensions |
|
|
|
X |
Note that marking up code blocks by indenting was deliberately not implemented in MarkAPL.
Documentation
A full documentation is available as an HTML page generated from Markdown with MarkAPL, as you would expect. This document is comprehensive and is therefore quite long: more than 30 pages.
There is also a cheat sheet available for the impatient APLer.
Project Page
For bug reports, future enhancements and a full version history see MarkAPL/ProjectPage
Original author: |
|
Responsible: |
|
Email: |