# maurodesouza/profile-readme-generator

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/maurodesouza-profile-readme-generator).**

3,687 stars · 1,815 forks · TypeScript · mit

## Links

- GitHub: https://github.com/maurodesouza/profile-readme-generator
- Homepage: https://profile-readme-generator.com
- awesome-repositories: https://awesome-repositories.com/repository/maurodesouza-profile-readme-generator.md

## Topics

`generator` `github` `github-profile-readme-generator` `github-readme-generator` `profile` `profile-readme` `profile-readme-generator` `readme`

## Description

This project is a GitHub profile README generator and markdown profile builder. It functions as a developer portfolio generator that converts personal information and preferences into a structured Markdown file for use as a public profile landing page.

The tool focuses on developer portfolio branding and GitHub profile customization. It uses a series of templates to automate the layout of a professional presence, allowing users to showcase their skills and social links.

The generator utilizes form-driven data collection and conditional content logic to determine which sections appear in the final document. The resulting configuration is processed through template-based generation and delivered as a static file export.

## Tags

### Development Tools & Productivity

- [README Generators](https://awesome-repositories.com/f/development-tools-productivity/github-integration-tools/readme-generators.md) — Functions as a README generator specifically designed to automate the creation of GitHub profile landing pages. ([source](https://profile-readme-generator.com))

### Part of an Awesome List

- [Profile Landing Pages](https://awesome-repositories.com/f/awesome-lists/devtools/github-profile-integrations/profile-landing-pages.md) — Offers tools to create and customize the aesthetic and content of GitHub profile landing pages.

### Content Management & Publishing

- [Template-Driven Generators](https://awesome-repositories.com/f/content-management-publishing/markdown-documentation/template-driven-generators.md) — Employs a template-driven generator to inject user data into structural Markdown layouts.
- [Markdown Profile Builders](https://awesome-repositories.com/f/content-management-publishing/markdown-profile-builders.md) — Formats user preferences and personal data into a professional Markdown layout for developer portfolios.
- [Personal Portfolio Generators](https://awesome-repositories.com/f/content-management-publishing/personal-portfolio-generators.md) — Provides a personal portfolio generator to help developers brand their professional presence on GitHub.

### DevOps & Infrastructure

- [Markdown](https://awesome-repositories.com/f/devops-infrastructure/configuration-management/file-based-configuration/profile-generators/markdown.md) — Automates the building of structured README files for personal profile pages via user data input.

### User Interface & Experience

- [Browser-Based File Exports](https://awesome-repositories.com/f/user-interface-experience/browser-based-file-exports.md) — Enables the generation and download of the final Markdown file directly from the browser using Blobs.
- [Conditional Rendering Logic](https://awesome-repositories.com/f/user-interface-experience/conditional-ui/conditional-rendering-logic.md) — Uses conditional rendering logic to determine which Markdown sections are included based on user preferences.
- [Template-Driven Input Forms](https://awesome-repositories.com/f/user-interface-experience/form-input-widgets/template-driven-input-forms.md) — Provides template-driven input forms that capture the specific variables needed to populate the profile README.