Comments (8)
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.
Ideally we would use something that produced the same output as on our existing site.
from ember-api-docs.
@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.
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.
Class details are in HTML format while field details are in Markdown format for some reason.
from ember-api-docs.
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.
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.
from ember-api-docs.
Related Issues (20)
- @ember/component/template-only page is blank HOT 1
- Dead link on /ember-data/3.26/classes/Model
- Documented object properties are not displayed HOT 1
- Replace jquery animation HOT 2
- Fix eslint issues
- Convert services to use native class syntax
- Add shoebox to mappings.json/ember.json/ember-<version>.json
- Algolia search is broken HOT 3
- Document nullish timer argument for cancel() HOT 1
- deprecate (ember/debug) docs are not pulling in right information? HOT 1
- Wrong 404 on navbar links
- Page not found in API documentation HOT 1
- API docs content should be rendered in the all available space for content
- Update components to extend glimmer/component and enable ember/no-classic-components rule
- Bug - Version dropdown has an error due to missing Ember Data 4.5
- Search does not list Class all properties nor methods
- String input "all", followed by quickly changing query breaks search bar HOT 4
- Redesign - style the function arguments and return type section HOT 1
- TextField support for ember 4
- 404 / missing EmberData API docs of old releases HOT 9
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ember-api-docs.