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.

Sign up for GitHub

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

Jump to bottom

Add support for adding markdown pages #2565

Open
mayank1513 opened this issue May 1, 2024 · 5 comments
Open

Add support for adding markdown pages #2565

mayank1513 opened this issue May 1, 2024 · 5 comments
Labels
duplicate This duplicates another issue enhancement Improved functionality
Milestone
v0.26.0

Comments

@mayank1513
Copy link

Search Terms

pages, markdown, md

Problem

Similar issue was reported earlier as well. However, it was closed citing a plugin. However, the plugins developed for one version do not work with the other. Also, we don't want to be locked to lower version of TypeScript to use Typedoc with lower version.

Suggested Solution

Please create a feature to automatically pick up markdown files from specified directory or path and include that in documentation.
@mayank1513 mayank1513 added the enhancement Improved functionality label May 1, 2024
@mayank1513
Copy link
Author

As of now, I just employed a quick hack - https://react18-tools.github.io/react18-global-store/

This suggests that it shouldn't be very difficult to add this feature with a little better aesthetics to the library.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented May 1, 2024

Duplicate of #247, this is the feature I'm hoping to include in the next typedoc minor release.

@Gerrit0 Gerrit0 added the duplicate This duplicates another issue label May 1, 2024
@mayank1513
Copy link
Author

Thanks. Let me know if I can help in any way. Do you have any open PR for this that I can review and see if I can add anything to it?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented May 1, 2024

Nothing up yet, I'm hoping to get to a working POC this weekend, or possibly the next.

Gerrit0 added a commit that referenced this issue May 3, 2024
@Gerrit0
Add DocumentReflection to represent markdown documents in generated…
bc6ae81 
… 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
Copy link
Collaborator

Gerrit0 commented May 4, 2024

0.26.0-beta.0 is up with this, announcement at #2567

@Gerrit0 Gerrit0 added this to the v0.26.0 milestone May 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
duplicate This duplicates another issue enhancement Improved functionality
Projects
None yet
Milestone
v0.26.0
Development

No branches or pull requests
2 participants
@Gerrit0 @mayank1513