Skip to content

This is a GitHub repository whose profile contains markdown elements and text to use for testing whether markdown rendering is accessible or not.

Notifications You must be signed in to change notification settings

andyfeller/markdown-lorem-ipsum

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 

Repository files navigation

markdown-lorem-ipsum

This is a GitHub repository whose profile contains markdown elements and text to use for testing whether markdown rendering is accessible or not. The content and markdown elements are based upon the light and dark styles of charmbracelet/glamour module.

Headers

First, we have the markdown variants:

markdown h1

markdown h2

markdown h3

markdown h4

markdown h5
markdown h6

Horizontal Rule

First, we have the markdown variants:


Images

First, we have the markdown variants:

Animated image of a cat playing bongos

Links

First, we have the markdown variants:

this is pure text

Animated image of a cat playing bongos

Code

First, we have the markdown variants:

gh api "/user"

QUERY='
query($endCursor: String){
  organization(login:"actions"){
    repositories(first:100, after:$endCursor){
      pageInfo{
        endCursor
        hasNextPage
      }
      nodes{
        name
        issues(states:OPEN){
          totalCount
        }
      }
    }
  }
}
'

gh api graphql -F query="$QUERY" --paginate --slurp | jq '[ .[].data.organization.repositories.nodes[].issues.totalCount ] | add'
this is just a code fence without a language applied.

this really shouldn't do anything exciting from a rendering perspective

Quotes

Note

Duplicating markdown code blocks in HTML is not completely possible because GitHub HTML rendering would strip the necessary CSS styles to colorize specific text.

In this example from andyfeller/gh-montage, the help usage code block is rendered with special span elements and classes to highlight meaningful tokens in the markdown for shell use case:

<pre>$ gh montage --help

Generate montage from GitHub user avatars.

USAGE
  gh montage [options] <span class="pl-k">&lt;</span>organization<span class="pl-k">&gt;</span>
  gh montage [options] <span class="pl-k">&lt;</span>organization<span class="pl-k">&gt;</span>/<span class="pl-k">&lt;</span>team<span class="pl-k">&gt;</span>
  gh montage [options] <span class="pl-k">&lt;</span>path/to/username file<span class="pl-k">&gt;</span>

FLAGS
  -a, --avatar-pixels <span class="pl-k">&lt;</span>integer<span class="pl-k">&gt;</span>       Size of GitHub avatar icons <span class="pl-k">in</span> pixels<span class="pl-k">;</span> default <span class="pl-s"><span class="pl-pds">'</span>48<span class="pl-pds">'</span></span>
  -d, --debug                         Enable debugging
  -f, --force                         Whether to overwrite output file <span class="pl-k">if</span> it exists
  -h, --help                          Displays <span class="pl-c1">help</span> usage
  -m, --montage-width <span class="pl-k">&lt;</span>integer<span class="pl-k">&gt;</span>       Width of GitHub montage <span class="pl-k">in</span> number of avatar icons<span class="pl-k">;</span> default <span class="pl-s"><span class="pl-pds">'</span>58<span class="pl-pds">'</span></span>
  -o, --output-file <span class="pl-k">&lt;</span>output-file<span class="pl-k">&gt;</span>     Name of GitHub montage file to generate, without <span class="pl-s"><span class="pl-pds">'</span>.jpg<span class="pl-pds">'</span></span> extension
  -p, --preserve                      Preserve temporary directory containing data</pre>

Tables

Avatar Name Role Handle
@williammartin William Engineering @williammartin
@andyfeller Andy Engineering @andyfeller
@mxie Melissa Engineering @mxie
@jtmcg Tyler Engineering @jtmcg
@bagtoad Kynan Engineering @bagtoad
@ryanhecht Ryan Product @ryanhecht

Lists

  • Incomplete checkbox
  • Complete checkbox
  1. First item: making sure nested bold is rendered correctly in ordered lists
  2. Second item: making sure nested italics is rendered correctly in ordered lists
  3. Third item: making sure multiple nested modifiers are rendered correctly in ordered lists
  4. Fourth item: making sure in-line code fencing is rendered correctly in ordered lists
  5. Fifth item: making sure strikethrough is rendered correctly in ordered lists
  • First item: making sure nested bold is rendered correctly in unordered lists
  • Second item: making sure nested italics is rendered correctly in unordered lists
  • Third item: making sure multiple nested modifiers are rendered correctly in unordered lists
  • Fourth item: making sure in-line code fencing is rendered correctly in unordered lists
  • Fifth item: making sure strikethrough is rendered correctly in unordered lists

About

This is a GitHub repository whose profile contains markdown elements and text to use for testing whether markdown rendering is accessible or not.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published