Giter VIP home page Giter VIP logo

awesome-readme-profile-preview's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.