Skip to content

Markdown in type documentation is not rendered #575

@astorije

Description

@astorije

Assuming I have the following GraphQL type and field:

type Foo {
 # **Hello**, is it _me_ you're `looking for`?
 bar: String!
}

The docs panel properly converts the Markdown tags in the comment when looking at documentation of the bar field:

screen shot 2017-08-19 at 16 38 39

but not when displaying the documentation of the Foo type:

screen shot 2017-08-19 at 16 38 30

I would be very happy to help fixing this and open a PR if you are interested.


This is not directly relevant for GraphiQL, but for the record, and for myself when I want to reproduce / test the fix, I'm using Sangria for Scala and this is the code for this type (that way I can just copy-paste it, /me lazy):

import sangria.macros.derive._

case class Foo(
  @GraphQLDescription("**Hello**, is it _me_ you're `looking for`?")
  bar: String
)

object Foo {
  implicit val FooType = deriveObjectType[Unit, Foo]()
}

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions