feat(generator): Enhance README customization with multiple layout templates - #8988
Conversation
|
@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. |
📦 Next.js Bundle Size Report (Gzipped Sizes)
📊 Summary of Totals
|
Aamod007
left a comment
There was a problem hiding this comment.
This is a great feature! Breaking down the monolithic README generation into specific section-builder functions in
eadme-generator.ts\ makes the code much cleaner and easier to maintain. The new \minimalist, \data-heavy, and \storyteller\ layout templates offer fantastic customization options for users, and dynamically ordering the sections based on the chosen template is implemented very elegantly.
Labels applied:
- type:feature: Adds multiple README layout templates and graph placement options.
- level:intermediate: Good architectural refactoring of string generation logic into manageable, composable blocks.
- quality:clean: The code is well-organized and much more readable now.
|
If you are still working on this, please push your latest changes or leave a comment to keep it active. |
waiting for maintainer. |
|
🎉 Congratulations @Rakshak05! Your PR has been successfully merged. 🚀 Thank you for contributing to CommitPulse. Your work helps us build a better tool for the community.
Keep building! 💻✨ |
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.