plugin-pages: @page for any file

[mokone91]

Hi!
Is its possible to add a link to page for not described pages in config?

example:
I want to add the link to my change-log file at the bottom of readme, i have around 40 packages and all of theme have readme and changelog files at the root. i do not want to discribe the whole pages tree..

[GerkinDev]

Hi there,

Well, I have more or less planned to add the concept of front matter similar to what can be done with some static side generators like hugo.

With such feature, you could specify a glob pattern to match pages, and specify the page infos (such as title or output) directly in the front matter.
Menu/directory configuration (such as children output directory or upcoming options evoked in #100) might then be done in an optional config file in each directory.

If you have any proposal/suggestion, I'm all ears.

Yet, what you want requires a full rework of the pages building process, and is not really a top priority.

[GerkinDev]

I just thought that changelogs may be auto-generated & published in other tools (GitHub releases, npm tarball, whatever), and thus, adding a front-matter does not really fit.

In your case, I would think of something like:

{
    pages: [
        {match: './packages/*/CHANGELOG.md', template: {
            moduleRoot: true,
            title: "{{CURRENT_MODULE.NAME}}",
            children: [
                {source: "./CHANGELOG.md",title: "Changelog"}
            ]
        }}
    ]
}

This would be expanded as following:

{
    pages: [
        {
            moduleRoot: true,
            title: "@example/foo",
            children: [
                {source: "./CHANGELOG.md",title: "Changelog"}
            ]
        },
        {
            moduleRoot: true,
            title: "@example/bar",
            children: [
                {source: "./CHANGELOG.md",title: "Changelog"}
            ]
        },
    ]
}

---

You could even append README to every modules with such pattern, making @knodes/typedoc-plugin-monorepo-readmes redundant:

{
    pages: [
        {match: './packages/*/README.md', template: {
            moduleRoot: true,
            title: "{{CURRENT_MODULE.NAME}}",
            source: "./README.md"
        }}
    ]
}

What do you think ?

[mokone91]

Yeah! Perfect for me!) is there a way to include index inside module lvl pages tree?

[GerkinDev]

Could you please clarify what you want to do ?

[mokone91]

Im happy to use glob pattern in root config when be available!

It will be nice if i can include index block directly to module subtree, but i understand that it not related to current topic and pages plug-in.
I subscribed to #109

Thanks!

[mokone91]

But, if we will use pages for readme - what we will see as module homepage?
for example:

Now:
Module1 -> shows readme(monorepo-readme-package)
 - page1 -> shows page1 (pages-pachage)
 - page2 -> shows page2 pages-pachage)
Module2
  ...


Then:
Module1 -> ???
 - readme -> shows readme (pages-package with glob support)
 - changelog -> shows changelog (pages-package with glob support)
Module2
  ...

[GerkinDev]

As I mentioned above, glob patterns would be expanded to the non-glob format:

        {match: './packages/*/README.md', template: {
            moduleRoot: true,
            title: "{{CURRENT_MODULE.NAME}}",
            source: "./README.md",
            children: [
              { source: './CHAMGELOG.md', title: 'Changelog'}
           ]
        }}

This would expand to

Module1 -> shows readme in Module1 + normal index
 - Changelog -> shows changelog of Module1
 - ...
Module2 -> shows readme in Module2 + normal index
 - Changelog -> shows changelog of Module2
 - ...

Would that matches your expectations ?
There would be an extra behavior, that merges deeply items, so that you could specify pages for modules both via glob expansion & explicitly like now

[mokone91]

Ahh, it's can be managed using moduleRoot: true, sorry miss that.

Yeah perfect! Thats exactly what I need.

[GerkinDev]

Yeah this option was introduced in 0.23.0, see the docs page.

Don't hesitate to suggest improvements to documentation