Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the codeblocks work for the website redesign #877

Open
2 tasks
mansona opened this issue Aug 24, 2023 · 1 comment
Open
2 tasks

Make the codeblocks work for the website redesign #877

mansona opened this issue Aug 24, 2023 · 1 comment
Assignees

Comments

@mansona
Copy link
Member

mansona commented Aug 24, 2023

Example page where it's not working: https://ember-api-do-website-re-9n6ekm.herokuapp.com/ember/release/classes/Application

Notes on the current implementation

  • The codeblocks come to us as HTML from the bucket
  • The ember-jsonapi-docs repo (the thing that converts the yuidoc to jsonapi) has a function in lib/markup.js that finds codeblocks and manually makes them like this.

Todo

  • get a sample of the input format that is passed to the lib/markup.js function to see what format it is
  • figure out if there is a possibility to consider the description key on the json-api response as markdown and use ember-showdown-prism to do the highlighting work
@mansona mansona converted this from a draft issue Aug 24, 2023
@MinThaMie MinThaMie moved this from Todo to In Progress in Redesign ember-api-docs Jan 25, 2024
@MinThaMie
Copy link
Contributor

This will be fixed upstream by the work @jaredgalanis and @mansona are doing #902

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

No branches or pull requests

3 participants