GitHub Flavored Markdown

Content for this site, and for all sites using the ASF-Pelican template, is structured using GitHub Flavored Markdown (GFM).

File extensions are md, markdown, mkd, and mdown. If you have an mdtext file, it is from the Apache CMS, which is deprecated as of summer, 2021. Change the file extension to md.

Sites built with the ASF-Pelican template use a version of cmark-gfm by GitHub through the pelican-gfm plugin that Infra created.

• Mastering Markdown.

• Detailed Specification with many examples.

• If your project previously built its site using the Apache CMS, here are some differences from markdown.pl that the CMS used:

  • HTML Blocks

    • Make sure the first line of any HTML block starts in column one.
    • A blank line terminates an HTML block
      • Exception to this rule for style, pre, and script.
    • Review Markdown content within an HTML block

  • Autolinks

    • www
    • url
    • email

  • Disallowed html the tagfilter extension disables certain HTML tags. The asfgenid plugin reenables script, style, and iframe HTML tags.

• Examples

• ID and Class annotations

## What is the Apache Software Foundation?  {#what}

The Apache Software Foundation (ASF) is a non-profit 501(c)(3) corporation,
incorporated in Delaware, USA, in June of 1999. The ASF is a natural
outgrowth of The Apache Group, which formed in 1995 to develop the Apache HTTP Server.

Set the class to display an image to float-right:

![Logo](images/logo.svg) {.float-right}

You can also float an HTML fragment at the right of the page display:

<div class=".pull-right" style="float:right; border-style:dotted; width:200px; padding:5px; margin:5px">

SEE INSTEAD: [Trademark Resources Site Map][resources].

</div>

• Migrating a site from the Apache CMS

If you are moving a project site of the Apache CMS and will be using the ASF-Pelican template:

• Change any mdtext file extension to md.
• Replace the multiple line notice: at the top of the file with a one-line reference to the Apache License.
• Any {#id} and {.class} annotations have any # tags between the annotation and the heading text removed.
• Only one {#id} or {.class} annotation is allowed on a tag.
• {.class} annotations are seldom used.