@typedef is not considered in documentation-theme-light

Open
#8 0 comments 0 reactions 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
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
css, yaml
Domain
documentation

Research direction

Reproduce the issue with @typedef declarations while using documentation.yml and the documentation-theme-light theme, then compare the generated output HTML with the output from another theme or without documentation.yml. Trace how the theme handles typedef content. Done means typedef-defined types appear in the generated HTML when documentation.yml and this theme are used.

Written by the indexing model from the issue text.

Description

I used @typedef for some of the types. Its not been coming in output html when I use documentation.yml But its working if I don't use this theme or if don't use documentation.yml

Dominant language
CSS
Stars
31
Forks
1
No merged PRs in 30d

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.

More from documentationjs/documentation-theme-light

All issues in documentationjs/documentation-theme-light

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.