Skip to content

Commit 369ca21

Browse files
authored
Update README.md
1 parent 771630c commit 369ca21

1 file changed

Lines changed: 26 additions & 12 deletions

File tree

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,34 @@
44
<img alt="Pharo" src="https://img.shields.io/static/v1?style=for-the-badge&message=Pharo&color=3297d4&logo=Harbor&logoColor=FFFFFF&label=" />
55
</a>
66

7-
Pillar is a markup syntax and tool-suite to generate documentation, books, websites and slides. Pillar is not new, it was invented around 2000 as a supporting language for [SmallWiki](https://www.slideshare.net/esug/smallwiki-smalltalk-wiki-towards-cms): one of the first wiki using OOP for real. Its ancestor was the markup for the Pier CMS and we extracted it from Pier to make it more applicable to different domains. The Pillar syntax is similar to markdown but its emphasis is on publishing and how it handles different types of links.
8-
9-
Now Pillar is now supporting Microdown syntax and we migrated all the support to Microdown while supporting the Pillar syntax for backward compatibility reasons. We can migrate automatically books from Pillar syntax to Microdown syntax (compatible with markdown).
7+
Pillar is a documentation compilation chain taking documents written in Microdown (and Pillar) and producing books and slides.
108

119
Pillar is now the name of the compilation chain and the syntax language is Microdown.
1210

13-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://img.shields.io/badge/license-MIT-blue.svg)
14-
![https://github.com/pillar-markup/pillar/workflows/unit.app/badge.svg](https://github.com/pillar-markup/pillar/workflows/unit.app/badge.svg)
15-
![https://github.com/pillar-markup/pillar/workflows/unitTests/badge.svg](https://github.com/pillar-markup/pillar/workflows/unitTests/badge.svg)
11+
## History
1612

17-
![https://github.com/pillar-markup/pillar/workflows/system/badge.svg](https://github.com/pillar-markup/pillar/workflows/system/badge.svg)
18-
![https://github.com/pillar-markup/pillar/workflows/integration.app/badge.svg](https://github.com/pillar-markup/pillar/workflows/integration.app/badge.svg)
13+
Pillar was a markup syntax and tool-suite to generate documentation, books, websites and slides. Pillar as a markup is not new, it was invented around 2000 as a supporting language for [SmallWiki](https://www.slideshare.net/esug/smallwiki-smalltalk-wiki-towards-cms): one of the first wiki using OOP for real. Its syntax was based on the one of the original Wiki from Ward Cunningham. From SmallWiki it became the markup of the Pier CMS (which was an application server written in Seaside).
14+
Then we extracted it from Pier to make it more applicable to different domains.
15+
In recent years we migrated all the transformation logic (parser, asts, visitors to Microdown).
16+
In the near future we will retire the Pillar markup from the compilation chain.
1917

18+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://img.shields.io/badge/license-MIT-blue.svg)
2019

2120
## Installation
2221

2322
### 1. Building from sources
2423
For HTTPS setup, execute the `build.sh` script found in the `scripts` directory:
2524

25+
### Here is the latesst version for Pharo 13.
26+
```bash
27+
$ git clone https://github.com/pillar-markup/pillar.git
28+
$ cd pillar
29+
$ git checkout v10.4.2
30+
$ chmod a+x ./scripts/build.sh
31+
$ ./scripts/build.sh
32+
```
33+
34+
2635
### Here is the latest version for Pharo 12.
2736
```bash
2837
$ git clone https://github.com/pillar-markup/pillar.git
@@ -142,7 +151,8 @@ It builds by default the export format found in `pillar.conf` at `defaultExport`
142151
**pillar updateTemplate**
143152
144153
## Contributing to Pillar
145-
The current pillar version is being developed using [Pharo12](www.pharo.org).
154+
155+
The current pillar version is being developed using [Pharo13](www.pharo.org).
146156
To contribute, the easiest way to to follow the previous scripts and send PullRequests.
147157
Use the latest dev as a root for your changes.
148158
@@ -177,16 +187,20 @@ The following script can be useful if you develop using the launcher and want to
177187
### For Pharo 12
178188
The development of Pillar and Microdown are now in Pharo 12.
179189
190+
- v10.4.2
191+
- Use Microdown generators
192+
- Mustache v1.3
193+
- Microdown v2.9.2
180194
- v10.4.0
181-
- Cleaned archetypes
182-
- New documentation inside the bod-book template with the full syntax explained.
195+
- Cleaned archetypes
196+
- New documentation inside the bod-book template with the full syntax explained.
183197
- Uses Microdown V2.7.1: introduces new elements to support Foliage and web generation. It improves the document checker. Now the following analyses are reported: duplicated anchors, references to unexisting anchors, unreferenced figures, missing figure files, and missing input files.
184198
- It has been tested with the bod-book updated archetype.
185199
186200
- v10.2.0
187201
- New book checkers: checks for undefined or duplicated anchors, bogus inputfile
188202
- Support for slides as header e.g. # a nice title
189-
Conversion of slides from pillar to Microdown
203+
- Conversion of slides from pillar to Microdown
190204
- Nicer support for extension e.g. {!comment|contents=sd thinks there is something fishy!} now can be expressed as {!comment|sd thinks there is something fishy!}`
191205
- Cleaned book. Now pillar archetype bod-book can fully build on GH - check the workflows files that are automatically installed.
192206
- Two new archetypes are proposed: microdown-mooc and microdown-headerformat-mooc.

0 commit comments

Comments
 (0)