Creating index file
Open
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- TypeScript
- Stars
- 277
- Forks
- 94
- Avg merge
- 8m
- Merged PRs (30d)
- 8
Description
I see a feature mentioned "Optional index: Optionally render a top level index" but i dont see a way to
create top level index file from the generated markdown. It can generate pages, classes, groups or everything in a single md file.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the implementation of the documented “Optional index” feature and the entry point that assembles generated Markdown. Check how pages, classes, groups, and the single-file output are produced; done means a top-level index can be generated and points to the selected output sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100