jots / neapolitan.cr

Multi-format Markup Streams

Home Page:https://trans.github.io/neapolitan.cr/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Neapolitan

Homepage | Development | Report Issue

DESCRIPTION

There are many markup and templating systems in the world. Why be limited to just one? Neapolitan gives you a whole box to pick from.

FEATURES

  • All the variety of a Whitman's Sampler.
  • And all the ease of a Hershey's K.I.S.S.
  • Our website has pretty colors 😄

Usage

Here's a very simple example of Neapolitan markup.

--- !metadata
name: World
--- !markdown
Hello {{name}}!

Library usage:

require "neapolitan"

Neapolitan.render(io_or_string)

Compatability

Neapolitan has a little bitty bit of brains to make static blog writers life easier. If your Neapolitan markup does not provide tags, the library will take a smart guess at the content. That means traditional Jekyll style posts/pages with YAML from matter followed by Markdown text will work!

---
name: World
---
Hello {{name}}!

This will work just like the prior example.

Installation

Add this to your application's shard.yml:

dependencies:
  neapolitan:
    github: trans/neapolitan.cr

Development

If you are an author of a Crystal-based markup format, please contact us via this project's Github issues.

Contributing

  1. Fork it ( https://github.com/trans/neapolitan.cr/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

  • trans - creator, maintainer

Copyrights

Neapolitan Copyright © 2010 Thomas Sawyer

Neapolitan is distributed under the terms of the MIT license.

THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

About

Multi-format Markup Streams

https://trans.github.io/neapolitan.cr/

License:MIT License


Languages

Language:Crystal 100.0%