-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |