README

Steroid

Vomit server side engine

Steroid is a powerful HTML-based templating engine that runs on Node.js and in the browser. It does all the heavy lifting for you and supports streaming, partials, asynchronous rendering (with promises and streams) and more.

Learn more about Steroid and even Try it Online!

Usage

No weird syntax or compilation. Steroid is pure HTML and JavaScript and a minute is enough to get your hands on it.

const html = require('steroid')
const http = require('http')

http.createServer((req, res) => {
  const country = 'France'
  
  // steroid returns a stream
  html`
    <article>
      <h2>Hello ${country}</h2>
      ${fetch('/api/weather?' + country).then(weather)}
    </article>
  `.pipe(res)
}).listen(3000)


function weather(forecast) {
  return html`
  <div class="weather">
    Weather is ${forecast.result}
    <ul>${forecast.cities.map(city)}</ul>
  </div>
  `
}

function city(name) {
  return html`<li>${name}</li>`
}

Even if Steroid works in your browser, we recommend you to use vomit to build rich applications in the front end. Vomit uses the same syntax than Steroid but leverage DOM instead of Streams.

Check out examples and docs for more information.

Installation

npm install steroid --save

Question

For questions and feedback please use our twitter account. For support, bug reports and or feature requests please make sure to read our community guideline and use the issue list of this repo and make sure it's not present yet in our reporting checklist.

Contribution

Steroid is an open source project and would not exist without its community. If you want to participate please make sure to read our guideline before making a pull request. If you have any steroid-related project, component or other let everyone know in our wiki.

Licence

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!