From 0bccc56c29cb10b2027d62c221c75451374b6eb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phaneDucasse?= Date: Wed, 30 Oct 2024 14:53:57 +0100 Subject: [PATCH] Update readme.md --- doc/readme.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/doc/readme.md b/doc/readme.md index a0e5247c..891bb0d3 100644 --- a/doc/readme.md +++ b/doc/readme.md @@ -1,3 +1,17 @@ # Microdown - -Microdown is the Pharo version of markdown. In general it is very close to github markdown, with two major differences and a number of smaller ones. Principal differences: - Microdown has a number of extension points to allow new functionality to be added without introducing new markdown syntax. In paticular Microdown has support for Latex, Pharo defined color highlighting of embedded code, inclusion of one document into an other - Microdown does not allow embedded html, as microdown is not restricted to being translated into html ## Syntax [This document](syntax.md) defines the syntax of Microdown [This document](extension.md) defines the extension mechanisms of Microdown ## API An important aspect of Microdown is its API, which allow you to work with Microdown from within Pharo. [This document](api.md) explaines the overall architecture of Microdown and the key methods.thods. \ No newline at end of file + +Microdown is the Pharo version of markdown. In general it is very close to github markdown, with two major differences and a number of smaller ones. + +Principal differences: + +Microdown has a number of extension points to allow new functionality to be added without introducing new markdown syntax. These extensions can be the level of main block such as environments or as inline element (such as footnote, citation). In particular Microdown has support for LaTeX, Pharo defined color highlighting of embedded code, inclusion of one document into another. + +Microdown supports metadata for figure, equation, ... It allows one to have anchor. + +## Syntax +[The Syntax Chapter](syntax.md) defines the syntax of Microdown. +[This Extension Chapter](extension.md) defines the extension mechanisms of Microdown. + +## API +An important aspect of Microdown is its API, which allow you to work with Microdown from within Pharo. +[The Chapter API](api.md) explains the overall architecture of Microdown and the key methods.