readme.md

Gularen CLI

Installation

Linux and MacOS

Run this command at the root of the project directory

sh script/install.sh

Windows

I do not have windows machine, but the code does not use platform specific features. You should be able to compile it on any platform that support C++17.

Manual

Display help page

gularen help

To HTML

gularen to html cli/resource/html/article.gr > article.html

HTML Template

Transpile gularen file to HTML with custom HTML template:

Article Template

gularen to html --template cli/resource/html/article.template.html cli/resource/html/article.gr > article.html

Files: document file, template file

Kanban Template

gularen to html --template cli/resource/html/kanban.template.html cli/resource/html/kanban.gr > kanban.html

Files: document file, template file

In the template file you can add special comments for substitution.

• <!--[content]-->: the document content
• <!--[toc]-->: the document table of contents
• <!--[[annotation-key]]-->: document annotation value of ~~ key: value

To Markdown

gularen to markdown document.gr
# or
gularen to md document.gr

To JSON

gularen to json document.gr