https://github.com/clearwater-rb/clearmarked
Markdown parser that emits Clearwater components
https://github.com/clearwater-rb/clearmarked
clearwater front-end markdown ruby
Last synced: 2 months ago
JSON representation
Markdown parser that emits Clearwater components
- Host: GitHub
- URL: https://github.com/clearwater-rb/clearmarked
- Owner: clearwater-rb
- License: mit
- Created: 2017-03-07T01:48:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-13T14:18:28.000Z (almost 8 years ago)
- Last Synced: 2024-04-25T04:21:29.304Z (about 1 year ago)
- Topics: clearwater, front-end, markdown, ruby
- Language: JavaScript
- Size: 12.7 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Clearmarked
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/clearmarked`. To experiment with that code, run `bin/console` for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'clearmarked'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install clearmarked
## Usage
TODO: Write usage instructions here
## 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 `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/[USERNAME]/clearmarked. 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.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).