Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vivid-inc/ash-ra-template

Expressive & customizable template system featuring Clojure language processing
https://github.com/vivid-inc/ash-ra-template

art clojure erb erb-syntax lisp template template-engine template-language template-library templates templating

Last synced: 4 months ago
JSON representation

Expressive & customizable template system featuring Clojure language processing

Host: GitHub
URL: https://github.com/vivid-inc/ash-ra-template
Owner: vivid-inc
License: apache-2.0
Created: 2017-11-20T03:07:20.000Z (about 7 years ago)
Default Branch: art-0.7.0
Last Pushed: 2023-12-18T13:42:12.000Z (about 1 year ago)
Last Synced: 2023-12-18T15:14:32.420Z (about 1 year ago)
Topics: art, clojure, erb, erb-syntax, lisp, template, template-engine, template-language, template-library, templates, templating
Language: Clojure
Homepage: https://vivid-inc.net
Size: 1.19 MB
Stars: 23
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # Ash Ra Template

[![License](https://img.shields.io/badge/license-Apache%202-blue.svg?style=flat-square)](LICENSE.txt)

[![Current version](https://img.shields.io/clojars/v/net.vivid-inc/art.svg?color=blue&style=flat-square)](https://clojars.org/net.vivid-inc/art)

[![cljdoc](https://cljdoc.org/badge/net.vivid-inc/art)](https://cljdoc.org/d/net.vivid-inc/art)

[![CircleCI](https://circleci.com/gh/vivid-inc/ash-ra-template/tree/art-0.7.0.svg?style=svg)](https://circleci.com/gh/vivid-inc/ash-ra-template/tree/art-0.7.0)

[![Codecov](https://codecov.io/gh/vivid-inc/ash-ra-template/branch/art-0.7.0/graph/badge.svg)](https://codecov.io/gh/vivid-inc/ash-ra-template)

Expressive & customizable template system featuring Clojure language processing

Tested with Clojure 1.10.0 and newer, and with Java 8 and newer LTS releases.

## Components

[ART library](art/README.md), the renderer proper. Includes detailed information about using the ART library and ART template syntax, rendering API and options, and processing.

[ART CLI library](art-cli/README.md) aggregates code common to the interpretation and processing of ART build tool and command line arguments.

[Clojure tool](clj-art/README.md) for rendering ART templates.

[Leiningen plugin](lein-art/README.md) for rendering ART templates.



## Quick Start

Include this library from Clojars by adding the latest version of ``net.vivid-inc/art`` to your project dependencies:

```clojure

{:deps {net.vivid-inc/art {:mvn/version "0.7.0"}}}         ; Clojure tools deps.edn

:dependencies [[net.vivid-inc/art "0.7.0"]]                ; Leiningen project.clj

```

Render a template string:

```clojure

(require '[vivid.art :as art])

(art/render "There were <(= (+ 1 2) )> swallows, dancing in the sky.")

```

Or, to render from a file:

```clojure

(art/render (slurp "index.html.art"))

```

#### Use cases

- Automating the bulk generation of data files, such as SQL unit tests in data science, per-language I18n/M10n files.

- HTTP server templating engine, dynamic web content.

- Static website generation (SSG), including HTML pages, blog articles, navigation, layouts, headers and footers, templated SVG images.

- Templating source code files, for example to encode project meta-data as variables written in a source file.

## Contributing

**Pull Requests** are welcome!

We work with people offering PRs to revise and iterate leading to solutions in accord with project goals and [release criteria](QUALITY.md).

Development topics and product roadmap are maininted in [DEVELOP.md](DEVELOP.md). 

Commits must include Signed-off-by indicating acceptance of the [Developer's Certificate of Origin](DCO.txt).

Unproductive behavior such as unkindness towards others and derailment is not tolerated.

## Attributions

- Original implementation by [Vivid Inc.](https://vivid-inc.net)

- Illustration by [Ruxandra](https://www.instagram.com/chocolatechiphelmet/).

![](assets/workshop.png)

Of the Clojure templating libraries we identified, none seemed to assist in porting a non-trivial amount of ERB-templated content to a Clojure-based static site generation tool.

We find the ability to in-line arbitrary Clojure code is intoxicatingly pragmatic (also expressed as: Enough rope to hang oneself).

Seeking to wield such expressive power in a general-purpose templating system, we wrote Ash Ra Template, or **ART**.

## License

© Copyright Vivid Inc.

[Apache License 2.0](LICENSE.txt) licensed.