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

[Feature]: Allow putting pages under namespaces (that are in same list as modules in generated documentation) #207

Open
Hi-Fi opened this issue Oct 15, 2022 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed scope(plugin-pages)

Comments

@Hi-Fi
Copy link

Hi-Fi commented Oct 15, 2022

Plugin

@knodes/typedoc-plugin-pages

What would you want ?

Example repo: https://github.com/Hi-Fi/typedoc-plugins-example/tree/external_pages

When documentation is generated, external page can only be put at main level, not under "module" (which is actually namespace).
image

If trying to put page under module_2, it's not possible as it's not with moduleRoot as that produces error:

Error: Invalid pages configuration: could not find a workspace named "module_2"

And if just adding empty page, that would duplicate module_2 in list.

@Hi-Fi Hi-Fi added enhancement New feature or request triage labels Oct 15, 2022
@GerkinDev
Copy link
Member

Hi,

The whole behavior of pages tree building is currently in a complete rework. Yet, I didn't thought about the ability to put pages in namespaces, or modules in a non-monorepo structure.

Currently, and in the upcoming release, only plain modules in monorepo are searched to attach pages to. This behavior is mainly intended for monorepos containing multiple independent packages. I'll keep this open waiting for some upvotes in order to see if this is a behavior multiple users need, or not.

@GerkinDev GerkinDev added help wanted Extra attention is needed scope(plugin-pages) and removed triage labels Oct 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed scope(plugin-pages)
Projects
None yet
Development

No branches or pull requests

2 participants