Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jekyll/jekyll-textile-converter

Textile converter for Jekyll.
https://github.com/jekyll/jekyll-textile-converter

jekyll-plugin textile

Last synced: about 2 months ago
JSON representation

Textile converter for Jekyll.

Awesome Lists containing this project

README

        

# Jekyll::Textile::Converter

Convert your `.textile` Jekyll content. For Jekyll 3.0 and up.

[![Build Status](https://travis-ci.org/jekyll/jekyll-textile-converter.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-textile-converter)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'jekyll-textile-converter'
```

And then execute:

```sh
$ bundle
```

Or install it yourself as:

```sh
$ gem install jekyll-textile-converter
```
Lastly, add it to your `_config.yml` file:

```yaml
plugins:
- jekyll-textile-converter
```

## Usage

Plop in a file with YAML front matter and watch Jekyll gobble it up and spit out beautiful HTML.

If you'd like to use a file extension other than `.textile`, you may
specify a comma-separated list of extensions in your `_config.yml`, like this:

```yaml
textile_ext: "textile,txtl,tl"
```

If that is the given configuration, then all files with `.textile`,
`.txtl`, and `.tl` file extensions will be read in and interpreted as
Textile. They must still contain YAML front matter.

## Contributing

1. Fork it ( https://github.com/jekyll/jekyll-textile-converter/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