https://github.com/jereinhardt/malvolio

A CLI for creating HTML emails
https://github.com/jereinhardt/malvolio

Last synced: about 2 months ago
JSON representation

A CLI for creating HTML emails

• Host: GitHub
• URL: https://github.com/jereinhardt/malvolio
• Owner: jereinhardt
• License: mit
• Created: 2018-11-03T19:56:11.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-08T15:37:38.000Z (almost 6 years ago)
• Last Synced: 2024-11-18T01:40:52.445Z (2 months ago)
• Language: CSS
• Size: 28.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Malvolio

Malvolio is a CLI tool that creates an easy workflow when developing HTML emails.

## Installation

In your terminal, install the gem from Rubygems.

```

gem install malvolio

```

## Usage

To create a new project, run the command

```

malvolio new  [--inky]

```

the `--inky` option will create a project that allows you to use The [Zurb Foundation's Inky Templating Language](https://foundation.zurb.com/emails/docs/inky.html) and comes bundled with their [Foundation Email CSS Framework](https://foundation.zurb.com/emails.html).

The `new` command will generate a new project with the following structure:

```

/project-name

  ├──tmp/

  ├──dist/

  └──src/

      ├──index.html

      └──scss/

          └──index.scss

```

Once you've done some work in the `src/` directory and are ready to build, you can run

```

malvolio build [PROJECT PATH] [--no-warnings]

```

Or, if you would like for your project to build automatically as you go, you can run

```

malvolio watch [PROJECT PATH] [--no-warnings]

```

Running either of these commands will output your final HTML email file to `dist/index.html`.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jereinhardt/malvolio.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).