@completium/open-tezos-md-task-util

Introduction

This utility generates the index.html of an Open Tezos task from a Markdown file.

Install

npm i -g @completium/open-tezos-md-task-util@latest

Run

The package installs the binary mdtask2html:

$ mdtask2html index.md > index.html

Metadata

It supports frontMatter style PEM task medata. For example:

---
id : example
authors : [[e-mail]]
---

# MD content here

PEM task metadata are defaulted to:

{
  "license" : "MIT",
  "language" : "en",
  "version": "0.1",
  "baseUrl" : "",
  "supportedLanguages": ["michelson", "ligo", "mligo", "religo", "jsligo", "smartpy", "archetype"],
  "evaluationTags": ["tezos"],
  "hasUserTests": "false",
  "testMode": "false",
  "limits" : {
    "*": {"time": "60000", "memory": "60000"}
  },
  "common" : "../../_common"
}

Language specific elements

The main feature is to dedicate an utterance element to a specific language, that is an element that is displayed only for the selected language : paragraph, inlined text, code block and link.

The following language tags are supported: michelson, ligo, mligo, religo, jsligo, smartpy and archetype.

Paragraph

The following md code:

<archetype>

Some content specific to Archetype

</archetype>

is compiled to:

<div select-lang="archetype" data-lang="archetype">
  <p>
    Some content specific to Archetype
  </p>
</div>

Inlined text

The following md code:

This is [inlined content specific to archetype](archetype).

is compiled to:

<p>
This is
<span select-lang="archetype" data-lang="archetype">
  inlined content specific to archetype
</span>
</p>

Code block

Language is specified with standard triple back quote followed by language id; for example:

```archetype
archetype test

variable counter : nat = 0
```

This is compiled to

<div select-lang="archetype" data-lang="archetype" data-show-source="true" data-code="archetype test

variable counter : nat = 0">
</div>

Link

It is possible to specify the language associated to a link by adding the language identifier after the url. For example, to display the link for archetype language:

[doc](https://archetype-lang.org/ "archetype")

This is compiled to:

<a href="https://archetype-lang.org/" target="_blank" rel="noopener noreferrer" select-lang="archetype" data-lang="archetype">doc</a>

Admonitions

5 types of admonitions are supported: info, note, tip, caution, danger

For example:

:::info
This is some information
:::

This is compiled to:

<div admonition admonition-type="info"><p>This is some info</p></div>

The script to process this div is available here.

Math expression

Mathematical expressions can be specified with $$ delimiters:

$$ (a+b)^2 = a^2 + 2*a*b + b^2 $$

This is compiled to:

<span class="math math-inline">(a+b)^2 = a^2 + 2*a*b + b^2</span>

This div may typically be processed with Katex.

HTML tags

It supports basic html tags (div, pre, code, ...). For example to add the language selector:

Choose your language : <div select-lang-selector="true" />