yard
yard copied to clipboard
not presenting the .md files correctly
When having .md files with data like this:
Usage
Bla bla Examples:
```ruby
my_hash={ loginame: :"cccccc", pwd => :"ckkkdkdkdk" } ```
The symbols ( :"xxxxx") are not displayed correctly and it are missing the first quotes, displaying:
my_hash={ loginame: :cccccc", pwd => :ckkkdkdkdk" }
Could you add which markdown gem you are using? And, version of YARD?
I dind't install by myself any gem for the markdown, YARD version: 0.9.12
If you didn't install any markdown libs, it will use rdoc to generate markdown output, which may or may not have full markdown compatibility depending on the version. Providing the output of gem list
or your Gemfile.lock would help a bit.
then which markdown lib do you recommend to have installed?
This is my whole gem list:
activesupport (5.1.3) addressable (2.5.2) amq-protocol (2.2.0) array_stats (0.6.0) asciidoctor (0.1.3) ast (2.3.0) atomic (1.1.13) auto_click (0.3.0) backports (3.8.0) bigdecimal (default: 1.3.0) builder (3.2.3, 3.2.2) bundler (1.16.1, 1.15.4) bunny (2.7.0) childprocess (0.7.1) chunky_png (1.3.8) ci_reporter (2.0.0) ci_reporter_test_unit (1.0.1) coderay (1.1.2) colorize (0.8.1) concurrent-ruby (1.0.5) cookiejar (0.3.3) cucumber (2.4.0) cucumber-core (1.5.0) cucumber-wire (0.0.1) daemons (1.2.4) debase (0.2.2.beta10, 0.2.1) debase-ruby_core_source (0.9.9) decisiontree (0.5.0) did_you_mean (1.1.0) diff-lcs (1.3, 1.2.5) diffy (3.2.0) domain_name (0.5.20170404) em-http-request (1.1.5) em-socksify (0.3.2) em-websocket (0.3.8) eventmachine (1.2.5 ruby x86-mingw32) facets (3.1.0) faraday (0.13.1) fastest-csv (0.0.4) ffi (1.9.18 x86-mingw32) gemcutter (0.7.1) gherkin (4.1.3) git (1.3.0) github-markup (0.7.5) hipbot (1.0.4) hipchat (1.6.0) hipchat_bot (0.1.1) http-cookie (1.0.3) http_parser.rb (0.6.0) httparty (0.15.6, 0.13.7) i18n (0.8.6, 0.6.5) io-console (default: 0.4.6) iso-iban (0.1.3) json (default: 2.0.2, 1.8.6) kramdown (1.1.0) liblinear-ruby (1.0.2) listen (1.1.6) log4r (1.1.10) method_source (0.9.0) mime-types (3.1) mime-types-data (3.2016.0521) mimemagic (0.3.2) mini_magick (4.8.0) mini_portile2 (2.3.0) minitest (5.11.3, 5.10.1, 4.7.5) multi_json (1.12.1, 1.7.9) multi_test (0.1.2) multi_xml (0.6.0, 0.5.5) multipart-post (2.0.0) mustermann (1.0.1, 1.0.0) mysql2 (0.4.9 x86-mingw32) nbayes (0.1.1) net-http-persistent (2.9) net-ldap (0.16.0) net-sftp (2.1.2) net-ssh (4.2.0, 4.1.0) net-ssh-gateway (2.0.0) net-telnet (0.1.1) netrc (0.11.0) nmatrix (0.2.4) nokogiri (1.8.1 x86-mingw32) oily_png (1.2.1) openssl (default: 2.0.3) packable (1.3.9) parallel (1.12.0) parser (2.4.0.0) pg (0.21.0 x86-mingw32) power_assert (0.4.1) powerpack (0.1.1) pry (0.11.2) psych (default: 2.2.2) public_suffix (3.0.0) puma (3.4.0) rack (2.0.3, 1.6.4) rack-cache (1.7.0) rack-protection (2.0.0, 1.5.3) rainbow (2.2.2) rake (12.0.0, 11.2.2) raml_parser (0.2.5) rb-fsevent (0.10.2) rb-inotify (0.9.10) rb-kqueue (0.2.5) rdiscount (2.1.7) rdoc (default: 5.0.0, 3.9.4) rdoc-view (0.1.2) redcarpet (2.3.0) RedCloth (4.2.9 x86-mingw32) regexp-examples (1.3.2) rest-client (2.0.2 x86-mingw32) rkelly-remix (0.0.7) rspec-support (3.0.4) rubocop (0.51.0) ruby-audio (1.6.1 x86-mingw32) ruby-debug-ide (0.6.1.beta9, 0.6.1.beta4) ruby-jmeter (3.1.08) ruby-oci8 (2.2.4.1 x86-mingw32) ruby-ole (1.2.12.1) ruby-progressbar (1.9.0) ruby-vnc (1.1.0) ruby2ruby (2.4.0) ruby_parser (3.10.1) rubygems-update (2.6.12) rubyzip (1.2.1) selenium-webdriver (3.5.1) sequel (5.1.0, 4.49.0, 4.1.1) sexp_processor (4.10.0) shotgun (0.9.2) sinatra (2.0.0, 1.4.7) sinatra-contrib (2.0.0) sinatra-websocket (0.3.1) spectrum-analyzer (0.2.0) spreadsheet (1.1.4) sqlite3 (1.3.9 x86-mingw32) stash-client (0.1.0) stomp (1.4.4) syntax (1.0.0) test-unit (3.2.5, 3.2.3) thin (1.7.2) thread_safe (0.3.6, 0.1.2) tilt (2.0.8, 2.0.2, 1.4.1) timify (0.0.3, 0.0.2, 0.0.1) tiny_tds (0.6.2 x86-mingw32) tzinfo (1.2.3, 0.3.37) unf (0.1.4) unf_ext (0.0.7.4 x86-mingw32) unicode-display_width (1.3.0) version_sorter (2.0.0) xmlrpc (0.2.1) xmpp4r (0.5.6) xmpp4r-hipchat (0.0.4) yard (0.9.12) yard-kramdown (0.0.1) yard-sd (0.0.4)
You have a couple of examples here, these two gems generated more or less... and form the same computer: https://www.rubydoc.info/gems/string_pattern/1.1.2 https://www.rubydoc.info/gems/nice_hash/1.1.0
First one wongly generating on RubyDoc.info and nice_hash no problem string_pattern: p :10:T".generate instead of :"10:T".generate
The github projects: https://github.com/MarioRuiz/string_pattern https://github.com/MarioRuiz/nice_hash