Skip to content

feat(docs): add customColumns to the docs-readme output target#6789

Merged
johnjenkins merged 1 commit into
v5from
v5-readme-docs-custom-cols
Jul 20, 2026
Merged

feat(docs): add customColumns to the docs-readme output target#6789
johnjenkins merged 1 commit into
v5from
v5-readme-docs-custom-cols

Conversation

@johnjenkins

@johnjenkins johnjenkins commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

What is the current behavior?

GitHub Issue Number: N/A

What is the new behavior?

Lets consumers append custom columns to the generated readme.md Properties and Events tables, driven by arbitrary JSDoc tags.

Usage

Just say you want to flag props that are configurable via a global store/design-token system

// stencil.config.ts
export const config: Config = {
  outputTargets: [
    {
      type: 'docs-readme',
      customColumns: {
        props: [
          {
            header: 'Configurable',
            content: (prop) =>
              prop.docsTags.some((t) => t.name === 'config') ? '✅' : '❌',
          },
        ],
      },
    },
  ],
};
// my-component.tsx

/** @config */
@Prop() theme: string;

Results in

Property Attribute Description Type Default Configurable
theme theme   string undefined

Documentation

Does this introduce a breaking change?

  • Yes
  • No

Testing

Other information

@johnjenkins
johnjenkins requested a review from a team as a code owner July 20, 2026 20:59
@johnjenkins johnjenkins changed the title feat(docs): docs-readme output, custom columns feat(docs): add customColumns to the docs-readme output target Jul 20, 2026
@johnjenkins
johnjenkins merged commit 93b08e8 into v5 Jul 20, 2026
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant