Github flavored markdown in YARD documentation

Tuesday, November 22, 2011
Would you like to do this in your README.md :

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

And get this as the output :


In your Gemfile :

  gem 'yard'
  gem 'redcarpet'
  gem 'github-markup'

In your .yardopts file :

--markup-provider=redcarpet
--markup=markdown

Resources


6 comments:

  • Josh

    Thanks for this useful post. But to my experience, only the yard and redcarpet gems are needed, and only --markup=markdown. Maybe the rest is by default now?

  • Karen

    This NFL Flag for Washington Redskins is constructed of polyester, measures 3x5 feet, and has two metal grommets for attaching to our 6' aluminum flagpoles or any of our tailgate pole systems. The perimeter of our NFL Flag for Washington Redskins is double stitched and the team logos are screen printed into the flag so they won't peel. Because of its large size, these flags are great to hang on any wall in your game room, sports room, garage.


    nfl american flags,
    stars and stripes flags,Tampa Bay Buccaneers house divided flags
    Tennessee Titans house divided flags, House Divided Flags,Sports Flags 3x5, Sports flags and banners,nfl House Divided Flags

  • Anne Lin

    Realizzato da Macron, il nuovo Cagliari 2016-17 jersey introduce un mezzo-e-mezzo design pulito con un collare tradizionale. Tutti i loghi degli sponsor sono di colore bianco, mentre sottile dettaglio è utilizzato sui fianchi, il collo e le maniche della casa kit Cagliari 16-17.maglie calcio 2017,
    maglie calcio poco prezzo, Maglia AS Roma a poco prezzo
    Maglia inter milan shop

  • Post a Comment