postmodern / spidr

A versatile Ruby web spidering library that can spider a site, multiple domains, certain links or infinitely. Spidr is designed to be fast and easy to use.
MIT License
800 stars 109 forks source link

Doc: Syntax highlight code blocks #70

Closed vfonic closed 5 years ago

postmodern commented 5 years ago

Arg, this may break YARD/kramdown. Both YARD and kramdown support GitHub Flavored Markdown (GFM), but in different ways. Also, the official documentation is already syntax highlighted.

vfonic commented 5 years ago

Ah, I see.

For me the official documentation is not syntax highlighted. It's just in a code block, but there's no syntax highlighting, hence the PR.

Which other websites is this Readme rendered on, where this change affects it negatively?

postmodern commented 5 years ago

I think I screwed up the official documentation link. Should have been: https://www.rubydoc.info/gems/spidr#Examples which does have syntax highlighting.

vfonic commented 5 years ago

You're right. Oh well, I'll close the PR then.