feat(generator): Enhance README customization with multiple layout templates - #8988
Open
Rakshak05 wants to merge 3 commits into
Open
feat(generator): Enhance README customization with multiple layout templates#8988Rakshak05 wants to merge 3 commits into
Rakshak05 wants to merge 3 commits into
Conversation
Contributor
|
@Rakshak05 is attempting to deploy a commit to the jhasourav07's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
This pull request introduces multiple layout templates for the README generator, enhancing user customization options. It aligns with previous decisions to improve user experience, such as the addition of a dark/light preview background toggle. This feature will allow users to visualize their README in different contexts, similar to how the background toggle enhances the contribution graph embed preview. Great work on this! Looking forward to your contributions. |
Contributor
📦 Next.js Bundle Size Report (Gzipped Sizes)
📊 Summary of Totals
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #7814
Added support for structural layout templates (
Classic,Minimalist,Data Heavy,Storyteller) inreadmeGenerator.tsand the README Editor UI, enabling users to customize the ordering of their profile sections.Summary of Changes:
LayoutTemplate('classic' | 'minimalist' | 'data-heavy' | 'storyteller') intypes.tsand addedlayoutTemplatetoGeneratorState.readmeGenerator.tsand arranged sections dynamically according to the chosen template.LayoutTemplateSectioncomponent in the editor sidebar with visual template badges and section order previews.PROFILE_PRESETSwith matching layout templates.readmeGenerator.layout-templates.test.tsverifying section reordering across all templates.Pillar
Visual Preview
(Optional: Attach a screenshot or GIF of the new Layout Template selector card from the generator UI)
Checklist before requesting a review:
CONTRIBUTING.mdfile.localhost:3000/api/streak?user=YOUR_USERNAME).npm run formatandnpm run lintlocally and resolved all errors (CI will fail otherwise).feat(themes): ...,fix(calculate): ...).README.mdif I added a new theme or URL parameter.