Giter Site home page Giter Site logo

haml-rs's Introduction

Update

I have had some personal issues come up and I have ignored this project for a few months because of it. After getting back into it I realized how badly it was written. I am working on rewriting the codebase so that it is clearer and easier to work with. While doing that I will be using the tests from the Ruby implementation to ensure that nothing is broken and work on achieving greater compatibility.

Haml-rs

Travis CI Build Status

This is a library for parsing Haml templates. You are able to get Haml-rs on Crates.io. The aim for this is to produce identical HTML to what the Ruby Haml gem produces.

Usage

To include haml-rs in your project add the following to your Cargo.toml:

[dependencies]
hamlrs = "0.4.2"

Then add the following to your code:

extern crate haml;

Example

Library

extern crate haml;

fn main() {
    let test_haml = "%span";
    let html = haml::to_html(&test_haml);
}

Stability

This software is in its early stages and as such there may be issues with stability.

If you find any bugs please don't hesitate to open an issue on github or, if you want, you can reach out directly to me at [email protected]

Integration tests

There are currently a few integration tests (and more to come). If you are going to contribute to an integration test please make sure that the HTML file that is generated by the Ruby Haml gem so that we can ensure that we are producing the same output as the reference implementation.

Current limitations

There is no variable/expression support in Haml-rs. This is something that is being thought about and if you want to add your thoughts you are more than welcome to comment here.

License

This project is licensed under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Haml-rs by you, shall be licensed as MIT, without any additional terms or conditions.

If you have any questions you can reach me via email at [email protected]

haml-rs's People

Contributors

jhartwell avatar mikong avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.