https://github.com/yasslab/markdown_formatter
Markdown formatter that removes unnecessary newlines.
https://github.com/yasslab/markdown_formatter
formatter gem markdown ruby
Last synced: about 1 year ago
JSON representation
Markdown formatter that removes unnecessary newlines.
- Host: GitHub
- URL: https://github.com/yasslab/markdown_formatter
- Owner: yasslab
- License: mit
- Created: 2017-07-06T04:11:10.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-08-21T03:09:57.000Z (almost 5 years ago)
- Last Synced: 2024-05-01T11:46:46.062Z (about 2 years ago)
- Topics: formatter, gem, markdown, ruby
- Language: Ruby
- Size: 49.8 KB
- Stars: 3
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MarkdownFormatter
Markdown formatter that removes unnecessary newlines, written in Ruby.
This polishes segments for making [Translation Memory](https://en.wikipedia.org/wiki/Translation_memory) more maintainable.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'markdown_formatter'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install markdown_formatter
## Usage
```
Usage: mdfmt [options] filepath
-w, --overwrite overwrite file instead of stdout
-v, --version display the version.
```
## 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/yasslab/markdown_formatter. 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
Copyright © 2017 [YassLab](https://yasslab.jp)
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
[](https://yasslab.jp/)