Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (37 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

45 lines (37 loc) · 1.71 KB

CONTRIBUTING

This course is written as markdown files which are rendered using MkDocs. If you would like to directly contributed, please use the Fork and Pull Request workflow.

Local Setup

We use the privacy plugin to be GDPR compliant. Unfortunately, the MathJax library that is used to render mathematical notation is not compatible with the plugin, so we include a copy of the JavaScript in the built site (see the gh-pages branch).

We do not include it in the source here, so to correctly build the site for publication or preview, you must install MathJax into the javascripts directory first. We use npm to handle the MathJax dependency.

cd APLCourse
npm install
mkdocs serve

Copy input

Code blocks are mostly styled to look like the Dyalog session, with six-space prompt input and flush-left output. We use custom css so that consecutive code blocks are visually merged, but only the input has a copy button.

Unfortunately, we haven't found a way to make this work in code blocks nested inside lists.

To have an input (six-space prompt) which can be copied without the output, write them as separate code blocks:

      +/⍳10
55

The APL qualifier means that blocks render with the class language-APL which can be used for syntax highlighting.

To have multiple input-output blocks visually merged to the same input block, separate them with a horizontal rule:

      ]box on -trains=tree
Was OFF -trains=box

      +⌿÷≢
  ┌─┼─┐
  ⌿ ÷ ≢
┌─┘