pillar icon indicating copy to clipboard operation
pillar copied to clipboard

Pillar markdown specification

Open kasperosterbye opened this issue 6 years ago • 2 comments

I would expect a specification of the pillar markdown to be available by link early in the readme file, or as a file at top level of this repository.

Actually, the only specification of pillar markdown is:

https://ci.inria.fr/pharo-contribution/view/Books/job/EnterprisePharoBook/lastStableBuild/artifact/book-result/PillarChap/Pillar.html

And also there you have to go all the way to the end to find the actual markdown. Is there a better overview somewhere.

kasperosterbye avatar Dec 15 '19 07:12 kasperosterbye

Yes you are right and it is not up to date. This is on my list to bring back to life the documentation available in https://github.com/SquareBracketAssociates/Booklet-PublishingAPillarBooklet

But I got killed by other tasks.

Ducasse avatar Dec 15 '19 08:12 Ducasse

I believe I have a “proof of concept” sorted out now. It is on:

https://github.com/kasperosterbye/PillarRichTextRender

which include the Metacello load instructions.

To try out, I suggest the following: Load it :-) The package and class comments should now render in pillar. Beware that they cannot be edited as is. You need to press command-r (or meta-r) to get it to show pillar source, which can be edited. It uses a simple regular expression to guestimate if the comments are written in Pillar, or is a plain text comment. The comments in the “Pillar-Calypso” package are simple examples of pillar based comments. There are some examples in the class side of “PRRichTextComposer”. There is a github renderer as well. It has an example as well - in class side of “GHMParser”. It renders a page it loads from the net. Comments, cheers as well as buuhs are welcome.

Best,

Ducasse avatar Feb 21 '20 09:02 Ducasse