A Simple, Extendable Markdown Renderer for Your Terminal

A Simple, Extendable Markdown Renderer for Your Terminal

charMD enables you to render a markdown text into a string, which printed in the terminal provides a well formatted output, instead of plain text.

🎩 charMD

A simple, extendable markdown renderer for your terminal.

🚧 This module is in early developement, expect breaking changes 🚧

charMD enables you to render a markdown text into a string, which printed in the terminal provides a well formatted output, instead of plain text.


Try it out

To see the general capabilities of this module run:

deno run https://deno.land/x/charmd/example.ts

To see, how a specific markdown gets rendered run:

deno run --allow-read https://deno.land/x/charmd/example.ts ./README.md


Simply import the module and call the renderMarkdown method with your markdown text.

import { renderMarkdown } from 'https://deno.land/x/charmd/mod.ts';

console.log(renderMarkdown('# Hello world 🌍!'));

🧩 Extensions

The module provides a way to extend it functionality with additional extensions, which can be provided in it's options param.

An extension can implement any of the Extension interface's methods, which are:

  • init: Called before AST generation, if a string is returned, it will override the input markdown for later extension's init fn and processing steps.
  • postAST: Called with the generated AST's root node, before any transformations
  • transformNode: Called with each node to do modifications on the node and it's children in the AST.
  • postTransform: Called with root, after all the transformations ran for all nodes.
  • generateNode: Called with each node. It should return the string representation of the rendered node,if the extension handles that specific node, or void, if its not handled by the extension.
  • postGenerate: Called after the string representation is created.

A simple extension, that renders link with green and blue instead of the built-in cyan would look something like this:

const LinkExt = {
    generateNode(genFn, node: Node, parent: Node, options: Options) {
          if(node.type === 'link') {
            const linkText = node.children?.map(ch => genFn(ch, node, options)).join('') || '';
            const link = `Link with text '${colors.blue(linkText)}' points to ${colors.cyan(node.url!)}`
            return colors.green(link);

    { extensions: [LinkExt] }

Direct use - cli.ts

For direct use in the terminal run cli.ts:

deno run --allow-net https://deno.land/x/charmd/cli.ts -r https://raw.githubusercontent.com/denoland/deno/master/README.md

Or install it with deno install

It has three options:

  • -s for rendering a string directly: -s "# markdown string"
  • -l for rendering a local file: -l ./README.md
  • -r for rendering a remote file: -r https://raw.githubusercontent.com/denoland/deno/master/README.md


The module itself requires no permissions to run.

If --unstable is provided, horizontal separators will consider the terminal's width.


  • No syntax highlight
  • No strikethrough or underline
  • No multiline tables cells
  • Possible hiccups with more complex markdowns

These could change in the future, but the aim is to keep the module's complexity minimal.

Also, many of these should also be solvable using extensions.


  • The main functions are also exported from the module, so for example you can use the toAST function to get your ast for the markdown and process it yourself.

  • As its core, it currently uses mdast-util-from-markdown, to get the AST, you can also provide extensions to it in the options unstable mdast property.

  • This module's core structure draws from @dephraims work with https://github.com/dephraiim/termd.


Feedback and contributions are always welcome. Open an issue or a PR, or contact me on the Deno discord.


  • fix lists
  • remove dots from codeblock backgrounds
  • links with images
  • # Header with *italic*
  • tests
  • fmt, lint
  • strikethrough, underline and combinations
  • Look into alternatives for the AST generation.

Download Details:

Author: littletof

Source Code: https://github.com/littletof/charmd

deno node nodejs javascript

Bootstrap 5 Complete Course with Examples

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Building a simple Applications with Vue 3

Deno Crash Course: Explore Deno and Create a full REST API with Deno

How to Build a Real-time Chat App with Deno and WebSockets

Convert HTML to Markdown Online

HTML entity encoder decoder Online

AEM Querybuilder for JavaScript (Browser, Node, Deno)

Helix Querybuilder .AEM Querybuilder for JavaScript (Browser, Node, Deno)

NKeys for JavaScript - Node.js, Browsers, and Deno

A public-key signature system based on Ed25519 for the NATS ecosystem system for JavaScript. The nkeys.js library works in Deno, Node.js, and the browser!

Javascript module for easily generating mazes,compatible with both Deno and Node

A work-in-progress Javascript maze generator module, compatible with both Deno and Node.

Deno Tutorial for Beginners: Deno vs. Node: Better Than NodeJS?

Deno is released, it’s time to find out if it can prove a worthy competition for Node.js. What is Deno? Why Deno can be considered an alternative to Node? The main differences between Deno and Node. Write a simple Deno app.

What is Deno? The Node.JS Killer? The Deno-minator to Node?

What is Deno? The Node.JS Killer? The Deno-minator to Node? Deno is the new hype and will it be better than node.js? Deno is a secure runtime for JavaScript and TypeScript that is based on the V8 JavaScript engine and the Rust programming language that addresses Node’s shortcomings