bitovi / bitovi/documentjs

See where a component is used in an application

Open
#127 1 comment 0 reactions 0 assignees View on GitHub
p3 style-guide
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

Likely very difficult to implement. In the short term, it may be worth adding a tag like:

```
@see foo.html .fooClass
@see bar.html .barClass
```

This could just draw focus to or even highlight something on a page.

Contributor guide

No contributing guide indexed for this repository

Research direction

No source files, tests, or entry points are named. Start by reviewing how documentation tags are parsed and rendered, then determine how @see references such as foo.html .fooClass should resolve and highlight a component. Done means the syntax is supported and the referenced element can be located or focused in the generated documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.