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:
```
gem install yard-commonmarker
```

Usage

Put following lines into .yardopts file:

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

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

Markup

Markup	Description
`commonmark`	See http://commonmark.org/
`markdown`	See `commonmark`

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.

Contributing

Bug reports and pull requests are welcome on GitLab. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.