Writing and organization / SERIES 04

Markdown and Code Showcase

See Markdown, code, terminal output and notes rendered by the template

Filed inClarislet Handbook
Topic · Getting started with Clarislet / Part 04View reading order →
On this page · 3 sectionsText and tasksTables and imagesCode and terminal output

This page shows how common Markdown and GFM elements render.

Text and tasks

Use bold, emphasis, strikethrough and inline code where they help.

Write down the question before looking for an answer.

  • Identify the question
  • Add a reproducible example

Tables and images

Element Purpose
Heading Name a section
Table Compare related information

A flow diagram from Markdown to HTML

Code and terminal output

reading-note.tstypescript
const question = 'What does the example show?';const answer = 'A reproducible Markdown example';console.log(question, answer);
Keep the question next to the answer.
Example outputterminal
$ node reading-note.js
A reproducible Markdown example
Before running code

Check the filename and the context of the example first.

See Topics and Reference Books for stable links.

Continue in topic order