https://github.com/tongueroo/cli_markdown

Generate markdown docs from cli docs
https://github.com/tongueroo/cli_markdown

Last synced: about 1 month ago
JSON representation

Generate markdown docs from cli docs

• Host: GitHub
• URL: https://github.com/tongueroo/cli_markdown
• Owner: tongueroo
• Created: 2018-02-26T13:41:49.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-03-03T01:37:48.000Z (almost 3 years ago)
• Last Synced: 2024-04-24T09:22:26.755Z (9 months ago)
• Language: Ruby
• Size: 22.5 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# CliMarkdown

Library generates markdown from a Thor CLI class.  The markdown is meant to be served as part of a Jekyll static website.

## Usage

To use, add the following to your `Rakefile`:

```ruby

require_relative "lib/your_tool"

require "cli_markdown"

desc "Generates cli reference docs as markdown"

task :docs do

  CliMarkdown::Creator.create_all(cli_class: YourTool::CLI, cli_name: "your_tool")

end

```

* The `YourTool::CLI` class must be a Thor class.

* The cli_name is the name of the cli command used for your tool.

To generate docs, you can call:

    rake docs

This will generate docs in the `docs/_reference` folder.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'cli_markdown'

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. 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]/cli_markdown.