https://github.com/pegasd/strings2markdown

Convert puppet-strings output to Markdown format
https://github.com/pegasd/strings2markdown

markdown puppet puppet-strings puppetfile

Last synced: 26 days ago
JSON representation

Convert puppet-strings output to Markdown format

• Host: GitHub
• URL: https://github.com/pegasd/strings2markdown
• Owner: pegasd
• License: mit
• Created: 2017-07-31T11:08:04.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-22T10:07:01.000Z (almost 7 years ago)
• Last Synced: 2024-10-11T10:22:55.158Z (about 1 month ago)
• Topics: markdown, puppet, puppet-strings, puppetfile
• Language: Ruby
• Homepage:
• Size: 43.9 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Strings2markdown

[![Gem Version](https://badge.fury.io/rb/strings2markdown.svg)](https://badge.fury.io/rb/strings2markdown)

[![Build Status](https://travis-ci.org/pegasd/strings2markdown.svg?branch=master)](https://travis-ci.org/pegasd/strings2markdown)

[![Coverage Status](https://coveralls.io/repos/github/pegasd/strings2markdown/badge.svg)](https://coveralls.io/github/pegasd/strings2markdown)

This gem is intended to generate the `Reference` part of puppet module's README.md.

## Installation

Add this line to your puppet module's Gemfile:

```ruby

gem 'strings2markdown'

```

and update your installation

```shell

bundle

```

## Usage

TODO:

- Write rake task.

- Write documentation for the rake task.

## Development

After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests.

Or, you can run `bin/simple_test` to generate YAML representation of `spec/fixtures/test_module` documentation and see how this works 

internally.

To install this gem onto your local machine, run `bundle exec rake install`.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pegasd/strings2markdown. 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).

## Code of Conduct

Everyone interacting in the Strings2markdown project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the

[code of conduct](https://github.com/pegasd/strings2markdown/blob/master/CODE_OF_CONDUCT.md).