lipp / lipp/doclets

support more "live" tags (jsfiddle, etc)

Open
#65 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
206
Forks
12
PR merge metrics
No merged PRs in 30d

Description

as suggested by @joscha

what about allowing custom tags and a widget definition for it - that way I could add a

```
@tonicdev src/bla/example22.js
```

that gets rendered like a playground and a

```
@jsfiddle src/browser/example54.js src/browser/file.css
```

that gets rendered in jsFiddle style based on what the widget thinks is best.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by locating the existing handling for live tags in the JavaScript documentation generator and determine how tag definitions are registered. Review the examples for @tonicdev and @jsfiddle, then define what custom tags and widget definitions must support and how their rendered output should be verified.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.