gbif / portal-feedback

User feedback for the GBIF API, website and published data. You can ask questions here. šŸ—Øā“
30 stars 16 forks source link

Does bug reports support all the Markdown referenced in the Markdown guide? #335

Closed gbif-portal closed 7 years ago

gbif-portal commented 7 years ago

Does bug reports support all the Markdown referenced in the Markdown guide?

A whole bunch of Markdown to test


It's very easy to make some words bold and other words italic with Markdown. You can even link to Google!


Sometimes you want numbered lists:

  1. One
  2. Two
  3. Three

Sometimes you want bullet points:

Alternatively,


If you want to embed images, this is how you do it:

Image of Yaktocat


Structured documents

Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a # to create headings. Multiple ## in a row denote smaller heading sizes.

This is a third-tier heading

You can use one # all the way up to ###### six for different heading sizes.

If you'd like to quote someone, use the > character before the line:

> Coffee. The finest organic suspension ever devised... I beat the Borg with it. > - Captain Janeway


There are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: var example = true. If you've got a longer block of code, you can indent with four spaces:

if (isAwesome){
  return true
}

GitHub also supports something called code fencing, which allows for multiple lines without indentation:

if (isAwesome){
  return true
}

And if you'd like to use syntax highlighting, include the language:

if (isAwesome){
  return true
}

GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath ā€” love your sweater!

But I have to admit, tasks lists are my favorite:

When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!

And, of course emoji! :sparkles: :camel: :boom:


fbitem-dataset83e20573-f7dd-4852-9159-21566e1e691e Reported by: @peterdesmet System: Chrome 59.0.3071 / Mac OS X 10.12.5 Referer: https://www.gbif.org/dataset/83e20573-f7dd-4852-9159-21566e1e691e/activity Window size: width 1319 - height 736 API log&_a=(columns:!(request,response,clientip),filters:!(),index:'prod-varnish-',interval:auto,query:(query_string:(analyze_wildcard:!t,query:'response:%3E499%20AND%20(request:%22%2F%2Fapi.gbif.org%22)')),sort:!('@timestamp',desc))&indexPattern=uat-varnish-&type=histogram) Site log&_a=(columns:!(request,response,clientip),filters:!(),index:'prod-varnish-',interval:auto,query:(query_string:(analyze_wildcard:!t,query:'response:%3E399%20AND%20(request:%22%2F%2Fdemo.gbif.org%22)')),sort:!('@timestamp',desc))&indexPattern=uat-varnish-&type=histogram)

peterdesmet commented 7 years ago

It looks like all the Markdown features (from the examples in this guide) are supported, except:

Blockquotes

Which is a bug.

MortenHofft commented 7 years ago

It's a feature

peterdesmet commented 7 years ago

As in: blockquotes are not supported by design? šŸ˜„