Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate pages corresponding to Markdown files in directories #1870

Closed
DanielFlaum opened this issue Feb 19, 2022 · 7 comments
Closed

Generate pages corresponding to Markdown files in directories #1870

DanielFlaum opened this issue Feb 19, 2022 · 7 comments
Labels
enhancement Improved functionality
Milestone

Comments

@DanielFlaum
Copy link

DanielFlaum commented Feb 19, 2022

TypeDoc currently includes the content of README.md in the generated index.html. It would be useful if README.mds in subdirectories also caused corresponding pages to be generated. Doing so would add a way for directories themselves to be documented, creating a place to discuss project organization or other things that apply to more than a single file, as well as a place to document non-TypeScript files.

This should probably be labelled enhancement and plugin idea.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 20, 2022

This is something I'd like to include in TypeDoc itself, but will probably be a part of the guides work that's planned for 0.24, probably won't happen for a while...

@Gerrit0 Gerrit0 added the enhancement Improved functionality label Feb 20, 2022
@cadavre
Copy link

cadavre commented Apr 4, 2022

Another, maybe simpler way, would be to just list a docs files with their path and create static docs from it, in a separate menu. Just to wrap existing docs into code-generated one.

@johnameyer
Copy link

I see the Guides project board is now closed - do there happen to be plans for this idea now?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 1, 2023

I believe I closed it since GitHub started redirecting "old" projects to the new projects, and haven't gotten around to creating a new one since I've been meaning to finish 0.24 first, which won't include it. Have been busy with other things recently...

@Voo2
Copy link

Voo2 commented May 13, 2023

I would go one step further and say that generally all md files should be taken into account.

Suggested Solution

Similar to what Compodoc does, it would be extremely helpful if typedoc would consider md (Markdown) files that are in the same directory as the class and have the same filename. These MD files could be displayed in a tab from the displayed class or linked quite high up in the document.

Example

  • startup-config.service.ts
  • startup-config.service.md (this is the md file that belongs to the file above and should be integrated into its documentation)

@LeaVerou
Copy link

Another vote for this. We have a monorepo-like structure with components living in their own directories, with their own READMEs. It would be nice if those READMEs were also picked up by typedoc.

Gerrit0 added a commit that referenced this issue May 3, 2024
… site

This is a very large change and needs a significant amount of testing still. It
seems to work correctly for TypeDoc's changelog, but there's still several
TODO items remaining before this goes in a full release.

Closes #247
Closes #1870
Closes #2288
Closes #2565
@Gerrit0 Gerrit0 modified the milestones: v0.27.0, v0.26.0 May 4, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 16, 2024

Fixed with TypeDoc 0.26, which is releasing 2024/06/21

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

6 participants