Giter Club home page Giter Club logo

Comments (8)

oskarrough avatar oskarrough commented on July 20, 2024

Any preferences for the implementation, does something already exist? Or do you want to use a https://github.com/isagalaev/highlight.js/ component?

from ember-api-docs.

Gaurav0 avatar Gaurav0 commented on July 20, 2024

Ideally we would use something that produced the same output as on our existing site.

from ember-api-docs.

acorncom avatar acorncom commented on July 20, 2024

@Gaurav0 @toddjordan ย This might be a useful starting point: https://github.com/ef4/ember-code-snippet If we do find it's useful, we're likely to want to use it for https://github.com/ember-learn/guias/ as well

from ember-api-docs.

toddjordan avatar toddjordan commented on July 20, 2024

Possibly ignorant question: Why is this already working for class details, but not for method/property/event details, and can they be handled in the same place?

from ember-api-docs.

Gaurav0 avatar Gaurav0 commented on July 20, 2024

Class details are in HTML format while field details are in Markdown format for some reason.

from ember-api-docs.

toddjordan avatar toddjordan commented on July 20, 2024

its in markdown in the code:
https://github.com/emberjs/ember.js/blob/master/packages/ember-glimmer/lib/component.js

I think ember-jsonapi-docs is converting it. Maybe we should also convert class/method/event details there as well.
https://github.com/ember-learn/ember-jsonapi-docs/blob/f7c1ffa868e5242c3414f69d2c089fbbd90893f1/index.js#L56

from ember-api-docs.

toddjordan avatar toddjordan commented on July 20, 2024

I created a PR for rendering the markdown at build time in ember-jsonapi-docs: ember-learn/ember-jsonapi-docs#6

from ember-api-docs.

toddjordan avatar toddjordan commented on July 20, 2024

image

from ember-api-docs.

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.