https://github.com/solnic/middleman-docsite
Various middleman extensions extracted from rom-rb and dry-rb websites
https://github.com/solnic/middleman-docsite
Last synced: 17 days ago
JSON representation
Various middleman extensions extracted from rom-rb and dry-rb websites
- Host: GitHub
- URL: https://github.com/solnic/middleman-docsite
- Owner: solnic
- License: mit
- Created: 2019-09-29T10:38:56.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-16T08:54:48.000Z (about 2 years ago)
- Last Synced: 2025-05-06T23:15:56.853Z (17 days ago)
- Language: Ruby
- Homepage:
- Size: 64.5 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Middleman::Docsite
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/middleman/docsite`. 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 'middleman-docsite'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install middleman-docsite
## 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/solnic/middleman-docsite. 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](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Middleman::Docsite project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/solnic/middleman-docsite/blob/master/CODE_OF_CONDUCT.md).