Home

Welcome to the wiki for the ELISA orientation repository!

The orientation repository contains the infrastructure for a website generated with documents written in markdown located on the WG's GitHub Cloud Pages site. This wiki contains the information needed to create, test and submit those documents for publication on the website.

GitHub Cloud Pages uses the jekyll package to generate html pages from the document sources. This repository is structured accordingly. jekyll provides the "kramdown" markdown extension package which provides certain facilities, such as css formatting, script tags, inline formatting as well as class and id HTML attributes, which are not allowed in GitHub Formatted Markup (gfm) and other markup flavours. gfm is the markdown flavour GitHub uses for markdown documents, such as READMEs and wiki contents, contained in GitHub repositories. jekyll is backwards-compatible to markdown. The WG website uses kramdown facilities, however, although not necessarily for content.

If your document doesn't use the WG-specific kramdown constructs, gfm may be sufficient. In this case, you can test your markdown with a number of tools that can produce an html file from markdown or you can create a document and display the formatted results using GitHub's web interface. Otherwise, you can create a local development environment which uses jekyll to generate the document. In this case, the document may contain kramdown commands, but must not.

The wiki documents:

• How to get started by setting up an appropriate document development environment
• The workflows for creating, submitting and reviewing documents
• How to use kramdown constructs for special situations
• Tips and tricks
• Markdown and kramdown reference materials