Skip to content

Add markdown documentation builder for design tokens - #22

Open
IchordeDionysos with Copilot wants to merge 7 commits into
task/mapper-themefrom
copilot/add-output-builder-markdown
Open

IchordeDionysos with Copilot wants to merge 7 commits into
task/mapper-themefrom
copilot/add-output-builder-markdown

Conversation

Copilot AI commented Jan 13, 2026

Copy link
Copy Markdown

Description

Adds a complementary builder that generates lib/tokens.md documenting all design tokens with their resolved values. Helps developers quickly look up actual values when seeing token references like context.color.fg.primary.base in code.

Changes:

  • New MarkdownDocumentationFactory builder outputs tokens.md with:
    • Tokens organized by set (global, light, dark, etc.)
    • Full token paths, types, and resolved values
    • Aliases and math expressions pre-evaluated via existing prepareTokens()
  • Registered as markdown_documentation_builder in build.yaml
  • Tests using build_test framework

Usage:

targets:
  $default:
    builders:
      design_tokens_builder:design_tokens_builder:
        enabled: true
      design_tokens_builder:markdown_documentation_builder:
        enabled: true

After running build_runner, lib/tokens.md contains entries like:

- **global.fontSize.sm**
  - Type: `fontSizes`
  - Value: `13.0`

Related issues & PRs

No related issues or PRs found.

Checklist

  • I added a PR description.
  • I linked all related issues and PRs I could find (no links if there are none).
  • If this PR changes anything about the main design_tokens_builder package (also README etc.), I created an entry in CHANGELOG.md (## UPCOMING RELEASE if the change on its own is not worth an update).
  • If this PR includes a notable change in the design_token_builder package, I updated the version according to Dart's semantic versioning.
  • If there is new functionality in code, I added tests covering all my additions.
  • All required checks pass.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://storage.googleapis.com/flutter_infra_release/flutter/78fc3012e45889657f72359b005af7beac47ba3d/dart-sdk-linux-x64.zip
    • Triggering command: /usr/bin/curl curl --retry 3 --continue-at - --location --output /tmp/flutter/bin/cache/dart-sdk-linux-x64.zip REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Help me build a complimentary output builder that generates a Markdown file that lists all tokens that were generated in a list with the resolved value.

This should help document what the values are when you are seeing something like:
context.color.fg.primary.base
in the codebase.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@CLAassistant

CLAassistant commented Jan 13, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ Prusdrum
✅ IchordeDionysos
❌ Copilot
You have signed the CLA already but the status is still pending? Let us recheck it.

Copilot AI changed the title [WIP] Add complimentary output builder for Markdown file generation Add markdown documentation builder for design tokens Jan 13, 2026
Copilot AI requested a review from IchordeDionysos January 13, 2026 20:04
simpleclub-bot and others added 7 commits January 13, 2026 20:47
Co-authored-by: IchordeDionysos <10195482+IchordeDionysos@users.noreply.github.com>
Co-authored-by: IchordeDionysos <10195482+IchordeDionysos@users.noreply.github.com>
Co-authored-by: IchordeDionysos <10195482+IchordeDionysos@users.noreply.github.com>
@IchordeDionysos
IchordeDionysos force-pushed the copilot/add-output-builder-markdown branch from 37f1703 to 2c5a824 Compare January 14, 2026 16:09
@IchordeDionysos
IchordeDionysos changed the base branch from main to task/mapper-theme January 14, 2026 16:11
@IchordeDionysos
IchordeDionysos marked this pull request as ready for review January 14, 2026 16:24

@Sese-Schneider Sese-Schneider left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RSLGTM

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

5 participants