Skip to content

Add support for adding markdown pages #2565

Closed
Closed
@mayank1513

Description

@mayank1513

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.

Activity

mayank1513

mayank1513 commented on May 1, 2024

@mayank1513
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

Gerrit0 commented on May 1, 2024

@Gerrit0
Collaborator

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

mayank1513

mayank1513 commented on May 1, 2024

@mayank1513
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

Gerrit0 commented on May 1, 2024

@Gerrit0
Collaborator

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

added a commit that references this issue on May 3, 2024
bc6ae81
Gerrit0

Gerrit0 commented on May 4, 2024

@Gerrit0
Collaborator

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

added this to the v0.26.0 milestone on May 5, 2024

8 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @Gerrit0@mayank1513

        Issue actions

          Add support for adding markdown pages · Issue #2565 · TypeStrong/typedoc