Giter Site home page Giter Site logo

Comments (4)

asiandrummer avatar asiandrummer commented on May 2, 2024

Thanks for the report - I'm checking this out.

from graphiql.

asiandrummer avatar asiandrummer commented on May 2, 2024

Added sanitizing option to DocExplorer

from graphiql.

lelong71 avatar lelong71 commented on May 2, 2024

It was kind of nice to be able to put a link in description.

from graphiql.

leebyron avatar leebyron commented on May 2, 2024

Yeah this is good. Just as a heads up for anyone who lands here with questions:

If you'd like to include some example code in a description, use backticks: `` to do so.

`<input type="checkbox">`

Becomes:

<input type="checkbox">

That just removes any ambiguity and ensures all markdown renderers will include your example code correctly and not accidentally render HTML or aggressively sanitize and remove it.

Also, markdown has syntax for including the types of things we want to encourage in description documentation like *italics*, **bold**, # Headers, and [links][http://url.com]

from graphiql.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.