Markdown Content Profile

Acrolinx supports GitHub-flavored Markdown (GFM) and CommonMark.

You'll define how you want Acrolinx to extract elements under Extraction in your Markdown Content Profile.

HTML Elements and Attributes

We use HTML element or attribute names to identify corresponding Markdown elements. For example, the element name for a level-two heading is h2.

See the GitHub-flavored Markdown Spec or CommonMark Spec for more details.

For Markdown that doesn't have obvious corresponding HTML, we've listed the specific Markdown element names.

h2

The following Markdown is identified with the Element Name h2:

## I'm a level-two heading

So am I
--------

<h2>And me too</h2>

a.title

The following Markdown is identified with Element Name a and the Attribute to Extract title:

My alternative title
My other alternative title

Scored by [Acrolinx](https://www.acrolinx.com "My alternative title").
 
Visit <a href="https://www.acrolinx.com" title="My other alternative title">Acrolinx</a>.

Markdown-Specific Elements and Attributes

In addition to the HTML elements that you can use, here's a list of Markdown-specific elements and attributes that might be useful for your Markdown Content Profile.

codeblock

The following Markdown is identified with the Element Name codeblock:

code1
code2
code3

Use the attribute title to identify "myTitle."

The following code1-line is indented by a tab:
 
    code1
 
```myTitle
code2   
```
 
~~~~~~~~~~~~~~~~~~~~
code3
~~~~~~~~~~~~~~~~~~~~

Autolinks (al)

Autolinks ( "http://www.example.com" in the following Markdown file) are identified with the element al and the al.href attribute.

Visit our <http://www.example.com> website!

Email Autolinks (ml)

Email autolinks ("mail@example.com" in the following Markdown file) are identified with the element ml:

Contact <mail@example.com>.

YAML Front Matter (yfm)

Identify the following Markdown as a YAML Front Matter block with the Element Name yfm:

---
name: Miyamoto Musashi
age: young
contact:
 email: email@domain.com
 address: some location
pets:
 - cat
 - dog
 - bat
match: !!js/regexp /pattern/gim
run: !!js/function function() { }
---

xref

Elements a and img have a new xref attribute that replaces href for cross references.

In the following example, these elements and attributes identify the Markdown cross references:

Element Name a and attribute xref identify "caption."
Element Name a and attribute xref identify "1."
Element Name img and attribute xref identify "img1."

See [caption]
See [Reference 1][1]
My ![image][img1]
 
## caption
 
[1]: https://www.acrolinx.com 
[img1]: /img/test.png

ref

Element ref identifies Markdown references. For example, the two references at the bottom of the Markdown below.

You can also use the following attributes:

Element Name ref and attributeid identify "1" and "2."
Element Name ref and attribute value identify both "https://www.acrolinx.com" and "http://www.wikipedia.de."
Element Name ref and attributetitle identify "German Wikipedia Site."

Scored by [Acrolinx][1].
Visit [the Acrolinx website][1]!
You may want to visit [Wikipedia][2] as well.
 
[1]: https://www.acrolinx.com 
[2]: http://www.wikipedia.de  "German Wikipedia Site"

imgdesc

The element imgdesc identifies an image's description such as alt text.

We don't support the HTML image.alt for Markdown Content Profiles because image descriptions can be a complex hierarchy. So, we offer the element imgdesc.

![image description](/foo/bar/foobar.png)

How can we help?

Search