{"id":778,"date":"2025-09-23T07:16:04","date_gmt":"2025-09-23T07:16:04","guid":{"rendered":"https:\/\/software.sil.org\/bjcree\/?page_id=778"},"modified":"2025-09-23T07:16:04","modified_gmt":"2025-09-23T07:16:04","slug":"markdown-test","status":"publish","type":"page","link":"https:\/\/software.sil.org\/bjcree\/markdown-test\/","title":{"rendered":"Markdown Test"},"content":{"rendered":"

This document gives examples of how to use markdown for font documentation, for both in-project docs (html, pdf) and product site page source (md). Although these three target doc types each support some unique capabilities (e.g. product site accordions) this doc focuses on markdown that works for all three types.<\/p>\n

Paragraphs, text formatting, line breaking<\/h2>\n

This paragraph gives examples of formatting that uses special enclosing characters: italic<\/em>, bold<\/strong>, inline code<\/code>.<\/p>\n

Here is a second paragraph. If you want to
\nbreak a line in a specific place the clearest way is to use <br><\/code>.<\/p>\n

Headings<\/h2>\n

Note that H1 is not used for font documentation pages.<\/p>\n

H2<\/h2>\n

The H2 is the most common heading type used.<\/p>\n

H3<\/h3>\n

H4<\/h4>\n

H5<\/h5>\n
H6<\/h6>\n

Tables<\/h2>\n\n\n\n\n\n\n
Unicode block<\/th>\nFont support<\/th>\n<\/tr>\n<\/thead>\n
C0 Controls and Basic Latin<\/td>\nU+0020..U+007E<\/td>\n<\/tr>\n
C1 Controls and Latin-1 Supplement<\/td>\nU+00A0..U+00FF<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

When text requires wrapping in cells, the relative width of columns can be somewhat adjusted by tweaking the --- | ---<\/code> line under the header:<\/p>\n\n\n\n\n\n\n
Unicode block<\/th>\nCharacters<\/th>\nLong explanation<\/th>\n<\/tr>\n<\/thead>\n
C0 Controls and Basic Latin<\/td>\nU+0020..U+007E<\/td>\nThis is a longer text to describe the basic Latin block<\/td>\n<\/tr>\n
C1 Controls and Latin-1 Supplement<\/td>\nU+00A0..U+00FF<\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Table columns can also be aligned using :---:<\/code> syntax:<\/p>\n\n\n\n\n\n\n
Left-aligned<\/th>\nCentered<\/th>\nRight-aligned<\/th>\n<\/tr>\n<\/thead>\n
This is a longer text to describe the basic Latin block<\/td>\nC0 Controls and Basic Latin<\/td>\nU+0020..U+007E<\/td>\n<\/tr>\n
More left-aligned text<\/td>\nC1 Controls and Latin-1 Supplement<\/td>\nU+00A0..U+00FF<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Lists<\/h2>\n

Ordered List<\/h3>\n
    \n
  1. First item<\/li>\n
  2. Second item<\/li>\n
  3. Third item<\/li>\n<\/ol>\n

    Unordered List<\/h3>\n