05 PhIO MicrodownForDocs

Current situation (a.k.a Pharo 90).

• In Pharo 90 help is managed using strings stored in methods.
• Class comments are strings that can contain Microdown. Microdown V1 is presented in https://hal.archives-ouvertes.fr/hal-03137098/

Planned and current work

We are working

• to support Help as microdown files that are stored on disc but can be embedded in image. Check https://github.com/pharo-spec/NewTools-DocumentationReader
• to support the rendering/edition of help files
• to support the browsing of books from within pharo
• to support the browsing of project docs.

We are about to release Microdown V2.0

Microdown V1 vs. Microdown V2

Besides many fixes, V2 has the following properties.

• V1 converts MD document trees into pillar trees and uses pillar visitors.
• V2 only uses MD documents trees and MD based visitors.

All development is happening in https://github.com/pillar-markup/MicroDown