Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ducasse authored Oct 30, 2024
1 parent aee4a24 commit 0bccc56
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions doc/readme.md
Original file line number Diff line number Diff line change
@@ -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## APIAn 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.

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.

0 comments on commit 0bccc56

Please sign in to comment.