# yard-commonmarker

Use [CommonMarker][] for ~[Markdown][]~ [CommonMark][] text markup.

_Note_: [Markdown][] markup support simulated by using [CommonMark][] instead.

## Installation

*   _For existing code_:

    1. Declare a dependency:
        *   _developing a gem_:

            Add this line to your gemspec:

            ```ruby
            spec.add_development_dependency 'yard-commonmarker'
            ```

        *   _developing an app_:

            Add this line to your application's Gemfile (in `development` group):

            ```ruby
            gem 'yard-commonmarker'
            ```
    1.  And then execute:

        ```bash
        bundle
        ```

        To install required dependencies.

*   _Or install it yourself if you have no code yet_:

    ```bash
    gem install yard-commonmarker
    ```

## Usage

Put following lines into `.yardopts` file:

```
--plugin yard-commonmarker
--markup-provider commonmarker
--markup commonmark
```

or


```
--plugin yard-commonmarker
--markup-provider commonmarker
--markup markdown
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 `bin/rake install`. To release a new version, update the version number in `lib/yard/commonmarker/version.rb`, and then run `bin/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 GitLab][yard-commonmarker]. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

© Alex Semyonov, 2017, [MIT License](http://opensource.org/licenses/MIT)

[CommonMarker]: https://github.com/gjtorikian/commonmarker "commonmarker gem"
[CommonMark]: http://commonmark.org/ "CommonMark. A strongly defined, highly compatible specification of Markdown"
[Markdown]: http://daringfireball.net/projects/markdown/syntax "Markdown: Syntax"
[YARD]: http://yardoc.org/ "YARD — A Ruby Documentation Tool"
[yard-commonmarker]: https://gitlab.com/alsemyonov/yard-commonmarker