[Enhancement] Auto-generate Website from Project

Open
#320 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

The issue does not name a file, test, or entry point; begin by reviewing the repository documentation and the TSDoc project scope. Compare the requested JSDoc-style website generation with what TSDoc currently provides, then determine whether a generator is an intended feature and define the expected output and acceptance criteria.

Written by the indexing model from the issue text.

Description

With jsdoc, I could easily auto-generate a whole website. Is something like this possible with tsdoc too, because I didn't find any description of it anywhere. If there is no way yet, will there be a way in the future maybe or is this completely out of the goals of this project?

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

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 microsoft/tsdoc

All issues in microsoft/tsdoc

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.