Skip to content

LIGMATV/awesome-readme-profile-preview

Repository files navigation

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

Powered by Docsify.js and docsify-theme-github

A realtime markdown preview of Awesome README Profiles by categories.

Screenshot Capture - 2024-05-26 - 15-52-15
Example of Awesome README Profile Preview

Inspired by awesome-github-profile-readme. since the last merged pull request in 2022, I start trying to create the new awesome-readmes project with realtime preview, and the same categories like on awesome-github-profile-readme.

Contents:

Categories

GitHub Actions 🤖

Game Mode 🚀

Code Mode 👨🏽‍💻

Dynamic Realtime 💫

A Little Bit of Everything 😃

Descriptive 🗒

Simple but Innovative Ones 🤗

Typing.. Mode 🎰

Anime 👾

Minimalistic ✨

GIFS 👻

Just Images 🎭

Badges 🎫

Fancy Fonts 🖋

Icons 🎯

Retro 😎

How to add your own

  1. Go to category folder, for example:
    If you want add your profile to GitHub Actions 🤖 category, go to github-actions folder.

  2. Create new file <username>.md The content of the file should be like this :

    [<username>](https://github.com/<username>)
    
    [](https://raw.githubusercontent.com/<username>/<username>/main/README.md ':include')

    (Change <username> to your GitHub username)
    Remember, if your README profile filename in lowercase (readme.md) so the README.md should be readme.md

  3. Add to this README.md
    Go to your category section and add like this :

    - [<username>](<category folder>/<username>.md)

    (Change <username> to your GitHub username, and change <category folder> to category folder name were you add)

  4. Create pull request
    Create yoir pull request and wait for a minute/a hour/a day/a week/a month/a year/a century (mostly) to get approved.

Confused?
If you confused how to do it, go to A Little Bit of Everything 😃 category and see how i add this, or see how others work.