README.textile

Glyph is a Rapid Document Authoring Framework.

Think of it like a sort of Ruby on Rails but for creating text documents instead of web sites. With Glyph, you can manage your documents tidily in projects that can be used to generate deliverables in different formats such as HTML or PDF (through Prince).

Main Features

Glyph uses a simple macro system to perform a wide variety of advanced tasks:

Include the value of any configuration setting (like author, title) in the document.

Filter input explicitly or implicitly, based on file extensions when including files.

Manage comments and todo items.

Installation

gem install glyph — simple, as always.

Essential Glyph commands

Glyph is 100% command line. Its interface resambles Git’s for its simplicity and power (thanks to the gli gem). Here are some example commands:

glyph init — to initialize a new Glyph project in the current (empty) directory.

glyph add introduction.textile — to create a new file called introduction.textile.

glyph compile — to compile the current document into a single HTML file.

glyph compile -f pdf — to compile the current document into HTML and then transform it into PDF using Prince.

glyph compile readme.glyph — to compile a readme.glyph located in the current directory into a single HTML file.

Glyph macros in a nutshell

Format your documents using Textile or Markdown, and use Glyph Macros to do everything else:

Glyph Source:

section[header[Something about Glyph]
You can use Glyph macros in conjunction
with _Textile_ or _Markdown_ to
produce HTML files effortlessly.
section[header[What about PDFs?|pdf]
Once you have a single, well-formatted HTML
file, converting it to PDF is
extremely easy with a 3rd-party
renderer like =>[http://www.princexml.com|Prince].
]
]

HTML Output:

<div class="section">
<h2 id="h_10">Something about Glyph</h2>
<p>You can use Glyph macros in conjunction with
<em>Textile</em> or <em>Markdown</em> to
produce HTML files effortlessly.</p>
<div class="section">
<h3 id="pdf">What about PDFs?</h3>
<p>Once you have a single, well-formatted HTML
file, converting it to PDF is
extremely easy with a 3rd-party renderer
like <a href="http://www.princexml.com">Prince</a>.</p>
</div>
</div>