Code blocks to support file titles

Open
#34 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Use the Ember.js guides example in packages/ember-glimmer/lib/component.js as the expected behavior, then trace how this tool generates HTML for API documentation code blocks. Add support for file paths to appear as code-block titles, and verify that the generated documentation matches the guides' behavior.

Written by the indexing model from the issue text.

Description

the ember.js guides support defining a file name with its path as in https://github.com/emberjs/ember.js/blob/04ac480e923ab7f345e30b7aad683bea2ffb7193/packages/ember-glimmer/lib/component.js#L72 and this file path shows up in the code block's title. The API docs fails to do this because the html generated by this tool doesn't support it. We need to add support for the same.

Dominant language
JavaScript
Stars
10
Forks
11
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ember-learn/ember-jsonapi-docs

All issues in ember-learn/ember-jsonapi-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.