DEV Community

Saleem Malik
Saleem Malik

Posted on

Dynamic GitHub readme

1) Sign in/ Sign up

Sign in / Signup to your GitHub account and create a new repository

Alt Text

2) Repository Name

You will be asked to give a repository name. Make sure your repository name and the account name are same.

Alt Text

3) Create Read me File

Its mandate that you should have “readme.md” file while initialising repo if not make sure you are adding it as part of your repository.

Another key thing to notice is that the repository must be a “public” repository.

Alt Text

4) Static readme generator

Once the repository is created with above criteria you will be seeing a readme.md file where you will describe about yourself.

I found a static readme generator site useful. Click here to generate yours.

Don’t hesitate to add a discussion note if you don’t find this information suffice. I ll respond ASAP.

Here is mine. Hope this article helps. Hit ❤ when you like this article.

(: Happy coding :)

Discussion (1)

Collapse
imshravan profile image
Shravan Kumar B

Hi, do check this project, to beautify your profile readme. Star it, if you like it.

GitHub Dynamic Animated Quote Generator

GitHub logo shravan20 / github-readme-quotes

Dynamic quote generator for your GitHub readmes

github-readme-quotes

Dynamic quote generator for your GitHub readmes

banner

alt PRs Welcome Open Source? Yes! GitHub contributors Pull Request Counts last commit deployment-status community chat

Github Readme Quotes

Copy and paste the following markdown content to display the quote.

![Quote](https://github-readme-quotes.herokuapp.com/quote)
Enter fullscreen mode Exit fullscreen mode

Themes

You can display your quote in different themes without any manual customization.

Use ?theme=THEME_NAME parameter as shown below.

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark)
Enter fullscreen mode Exit fullscreen mode

Available Themes

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

Gotham

Quote

Dark

Quote

Light Theme

Quote

You can explore different themes here.

Feel free to contribute different themes.

Layouts

You can also change the layout of your templates.

Use ?layout=LAYOUT parameter as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&layout=socrates)
Enter fullscreen mode Exit fullscreen mode

Layout 1 (Default)

Quote

Layout 2 (Socrates)

Quote

You can explore different layouts here.

Feel free to contribute different layouts.

Animations

You can also add animations to your templates.

Use ?animation=ANIMATION paramater as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&animation=grow_out_in)
Enter fullscreen mode Exit fullscreen mode

Animation 1

Quote

You can explore different animations…