Skip to content

feat: enhance file name transformer with additional options#555

Merged
satnaing merged 2 commits into
mainfrom
feat/enhance-file-name-transformer
Jul 9, 2025
Merged

feat: enhance file name transformer with additional options#555
satnaing merged 2 commits into
mainfrom
feat/enhance-file-name-transformer

Conversation

@satnaing

@satnaing satnaing commented Jul 9, 2025

Copy link
Copy Markdown
Owner

Description

  • Add v2 badge-style option as alternative to v1 tab-style
  • v2 features: border, rounded corners, positioned with CSS custom property
  • v1 features: tab-style with rounded top corners, muted background
  • Add hideDot option to control green dot indicator visibility
  • Include comprehensive JSDoc documentation with usage examples
  • Support both styling variants with configuration parameters

Comparison: v1 and v2

v1 v2
image image

V1

export default defineConfig({
  // ...
  markdown: {
    // ...
    shikiConfig: {
      // ...
      transformers: [
        transformerFileName({ style: "v1", hideDot: false }),
        transformerNotationHighlight(),
        transformerNotationWordHighlight(),
        transformerNotationDiff({ matchAlgorithm: "v3" }),
      ],
    },
  },
  // ...
});

V2

export default defineConfig({
  // ...
  markdown: {
    // ...
    shikiConfig: {
      // ...
      transformers: [
        transformerFileName({ style: "v2", hideDot: false }),
        transformerNotationHighlight(),
        transformerNotationWordHighlight(),
        transformerNotationDiff({ matchAlgorithm: "v3" }),
      ],
    },
  },
  // ...
});

Types of changes

  • Bug Fix (non-breaking change which fixes an issue)
  • New Feature (non-breaking change which adds functionality)
  • Documentation Update (if none of the other choices apply)
  • Others (any other types not listed above)

Checklist

  • I have read the Contributing Guide
  • I have added the necessary documentation (if appropriate)
  • Breaking Change (fix or feature that would cause existing functionality to not work as expected)

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 9, 2025

Copy link
Copy Markdown

Deploying astro-paper with  Cloudflare Pages  Cloudflare Pages

Latest commit: b16c7c7
Status: ✅  Deploy successful!
Preview URL: https://7a322309.astro-paper.pages.dev
Branch Preview URL: https://feat-enhance-file-name-trans.astro-paper.pages.dev

View logs

satnaing added 2 commits July 9, 2025 23:31
- Add v2 badge-style option as alternative to v1 tab-style
- v2 features: border, rounded corners, positioned with CSS custom property
- v1 features: tab-style with rounded top corners, muted background
- Add hideDot option to control green dot indicator visibility
- Include comprehensive JSDoc documentation with usage examples
- Support both styling variants with configuration parameters
@satnaing
satnaing force-pushed the feat/enhance-file-name-transformer branch from 58626e9 to b16c7c7 Compare July 9, 2025 16:32
@satnaing
satnaing merged commit c863c82 into main Jul 9, 2025
5 checks passed
@satnaing
satnaing deleted the feat/enhance-file-name-transformer branch July 9, 2025 16:35
jxgla pushed a commit to jxgla/astro-paper that referenced this pull request Mar 10, 2026
…#555)

- Add v2 badge-style option as alternative to v1 tab-style
- v2 features: border, rounded corners, positioned with CSS custom property
- v1 features: tab-style with rounded top corners, muted background
- Add hideDot option to control green dot indicator visibility
- Include comprehensive JSDoc documentation with usage examples
- Support both styling variants with configuration parameters
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