mirror of
https://github.com/rahuldkjain/github-profile-readme-generator.git
synced 2026-08-24 10:13:30 -05:00
Fix GitHub spelling
This commit is contained in:
@@ -1,10 +1,10 @@
|
||||
<p align="center">
|
||||
<a href="https://rahuldkjain.github.io/gh-profile-readme-generator">
|
||||
<img alt="Github Profile Readme Generator" src="./src/images/mdg.png" width="60" />
|
||||
<img alt="GitHub Profile Readme Generator" src="./src/images/mdg.png" width="60" />
|
||||
</a>
|
||||
</p>
|
||||
<h1 align="center">
|
||||
Github Profile Readme Generator
|
||||
GitHub Profile Readme Generator
|
||||
</h1>
|
||||
|
||||
<p align="center">
|
||||
@@ -39,7 +39,7 @@
|
||||
<i>Loved the tool? Please consider <a href="https://paypal.me/rahuldkjain">donating</a> 💸 to help it improve!</i>
|
||||
</p>
|
||||
|
||||
#### Tired of editing Github Profile README with new features?
|
||||
#### Tired of editing GitHub Profile README with new features?
|
||||
This tool provides an easy way to create github profile readme with latest addons like `visitors count`, `github stats` etc.
|
||||
|
||||
#### 🚀 Try it out: [Live demo](https://rahuldkjain.github.io/gh-profile-readme-generator)
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
module.exports = {
|
||||
pathPrefix: `/gh-profile-readme-generator`,
|
||||
siteMetadata: {
|
||||
title: `Github Profile Readme Generator`,
|
||||
title: `GitHub Profile Readme Generator`,
|
||||
description: `Prettify your github profile using this amazing readme generator.`,
|
||||
author: `@rahuldkjain`,
|
||||
},
|
||||
|
||||
@@ -48,13 +48,13 @@ const Addons = (props) => {
|
||||
<div className="checkbox">
|
||||
<label htmlFor="dev-dynamic-blogs" className="checkboxLabel">
|
||||
<input id="dev-dynamic-blogs" type="checkbox" checked={props.data.devDynamicBlogs}
|
||||
onChange={event => props.handleCheckChange('devDynamicBlogs')} /> display latest dev.to blogs dynamically (Github Action)
|
||||
onChange={event => props.handleCheckChange('devDynamicBlogs')} /> display latest dev.to blogs dynamically (GitHub Action)
|
||||
</label>
|
||||
</div>
|
||||
<div className="checkbox">
|
||||
<label htmlFor="medium-dynamic-blogs" className="checkboxLabel">
|
||||
<input id="medium-dynamic-blogs" type="checkbox" checked={props.data.mediumDynamicBlogs}
|
||||
onChange={event => props.handleCheckChange('mediumDynamicBlogs')} /> display latest medium blogs dynamically (Github Action)
|
||||
onChange={event => props.handleCheckChange('mediumDynamicBlogs')} /> display latest medium blogs dynamically (GitHub Action)
|
||||
</label>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -72,7 +72,7 @@ const Header = props => {
|
||||
target="blank"
|
||||
>
|
||||
<div className="github-button">
|
||||
<RepoForkedIcon size={16} className="fork-icon" /> Fork on Github{" "}
|
||||
<RepoForkedIcon size={16} className="fork-icon" /> Fork on GitHub{" "}
|
||||
<span className="github-count">{stats.forksCount}</span>
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@@ -52,7 +52,7 @@ const Markdown = (props) => {
|
||||
}
|
||||
return '';
|
||||
}
|
||||
const GithubStats = (props) => {
|
||||
const GitHubStats = (props) => {
|
||||
let link = "https://github-readme-stats.vercel.app/api?username=" + props.github + "&show_icons=true"
|
||||
if (props.show) {
|
||||
return (<>{`<p> <img align="center" src="${link}" alt="${props.github}" /></p>`}<br /><br /></>);
|
||||
@@ -112,7 +112,7 @@ const Markdown = (props) => {
|
||||
(props.data.mediumDynamicBlogs && props.social.medium && isMediumUsernameValid(props.social.medium))} /></>
|
||||
<><DisplaySkills skills={props.skills} /></>
|
||||
<><DisplayTopLanguages show={props.data.topLanguages} showStats={props.data.githubStats} github={props.social.github} /></>
|
||||
<><GithubStats show={props.data.githubStats} github={props.social.github} /></>
|
||||
<><GitHubStats show={props.data.githubStats} github={props.social.github} /></>
|
||||
{isSocial(props.social) ? `<p align="center">` : ''} <br />
|
||||
<><DisplaySocial base='https://codepen.io' icon='https://cdn.jsdelivr.net/npm/simple-icons@3.0.1/icons/codepen.svg'
|
||||
username={props.social.codepen} /></>
|
||||
|
||||
@@ -90,7 +90,7 @@ const MarkdownPreview = (props) => {
|
||||
}
|
||||
return null;
|
||||
}
|
||||
const GithubStatsPreview = (props) => {
|
||||
const GitHubStatsPreview = (props) => {
|
||||
let link = "https://github-readme-stats.vercel.app/api?username=" + props.github + "&show_icons=true"
|
||||
if (props.show) {
|
||||
return (<div className="github-stats-card"><img src={link} alt={props.github} /></div>)
|
||||
@@ -122,7 +122,7 @@ const MarkdownPreview = (props) => {
|
||||
<SkillsPreview skills={props.skills} />
|
||||
<div className="github-cards">
|
||||
<TopLanguagesPreview show={props.data.topLanguages} github={props.social.github} />
|
||||
<GithubStatsPreview show={props.data.githubStats} github={props.social.github} />
|
||||
<GitHubStatsPreview show={props.data.githubStats} github={props.social.github} />
|
||||
</div>
|
||||
<SocialPreview social={props.social} />
|
||||
</div>
|
||||
|
||||
@@ -7,13 +7,13 @@ title: "👨💻 About"
|
||||
<img src="https://img.shields.io/github/license/rahuldkjain/github-profile-readme-generator?style=flat-square" alt="github-profile-readme-generator licence" />
|
||||
</a>
|
||||
|
||||
**Github Profile README Generator** is an OSS(Open Source Software) that provides a cool interface to generate Github profile README in markdown.
|
||||
**GitHub Profile README Generator** is an OSS(Open Source Software) that provides a cool interface to generate GitHub profile README in markdown.
|
||||
|
||||
The tool aims to provide hassle-free experience to add trending addons like profile **visitors count**, **github-stats**, **dynamic blog posts** etc.
|
||||
|
||||
The profile should be neat and minimal to give a clear overview of the work. Non-uniform icons, too much content, too much images/gifs distracts visitors to see your actual work.
|
||||
|
||||
To solve this, Github Profile README Generator came into existence.
|
||||
To solve this, GitHub Profile README Generator came into existence.
|
||||
|
||||
So many developers contributed to the project and made it more awesome to use. You can contribute too to make it grow even further.
|
||||
|
||||
|
||||
@@ -4,12 +4,12 @@ date: "2019-05-04"
|
||||
title: "🚀 Addons"
|
||||
---
|
||||
|
||||
Github Profile README Generator tool uses few open-source addons developed by other developers. Including such features makes the tool useful. The developers of this tool is very grateful to use these awesome addons.
|
||||
GitHub Profile README Generator tool uses few open-source addons developed by other developers. Including such features makes the tool useful. The developers of this tool is very grateful to use these awesome addons.
|
||||
|
||||
## [Github README Stats](https://github.com/anuraghazra/github-readme-stats)
|
||||
## [GitHub README Stats](https://github.com/anuraghazra/github-readme-stats)
|
||||
⚡️ Dynamically generated stats for your github readmes
|
||||
|
||||
#### Github Stats Card
|
||||
#### GitHub Stats Card
|
||||
<a href="https://github.com/rahuldkjain" target="blank">
|
||||
<img src="https://github-readme-stats.vercel.app/api?username=rahuldkjain&show_icons=true" width="320" alt="Rahul's github stats"/>
|
||||
</a>
|
||||
@@ -25,7 +25,7 @@ You can customize the theme too. See how to customize yours [here](https://githu
|
||||
|
||||
<br/>
|
||||
|
||||
## [Github Profile Views Counter](https://github.com/antonkomarev/github-profile-views-counter)
|
||||
## [GitHub Profile Views Counter](https://github.com/antonkomarev/github-profile-views-counter)
|
||||
It counts how many times your GitHub profile has been viewed. Free cloud micro-service.
|
||||
|
||||

|
||||
|
||||
@@ -6,7 +6,7 @@ title: "💵 Support OSS"
|
||||
|
||||
> Think of giving not as a duty but as a privilege --John D. Rockefeller Hr.
|
||||
|
||||
🚀 Github Profile README Generator tool is free and will always be free. Numerous developers has put their time and efforts to make this tool more powerful. However, these developers are doing their full time job along with open-source contributions.
|
||||
🚀 GitHub Profile README Generator tool is free and will always be free. Numerous developers has put their time and efforts to make this tool more powerful. However, these developers are doing their full time job along with open-source contributions.
|
||||
|
||||
You can come forward to support the developers by making small donations. You will never know what this support mean to them. If you find the tool really helpful, then it will be very grateful to support the tool 🙇.
|
||||
|
||||
|
||||
+7
-7
@@ -24,7 +24,7 @@ import {
|
||||
} from "@primer/octicons-react"
|
||||
import SEO from "../components/seo"
|
||||
import {
|
||||
isGithubUsernameValid,
|
||||
isGitHubUsernameValid,
|
||||
isMediumUsernameValid,
|
||||
} from "../utils/validation"
|
||||
|
||||
@@ -199,11 +199,11 @@ const IndexPage = () => {
|
||||
trimDataValues(link, setLink)
|
||||
resetCopyMarkdownButton()
|
||||
if (data.visitorsBadge || data.githubStats || data.topLanguages) {
|
||||
if (social.github && isGithubUsernameValid(social.github)) {
|
||||
if (social.github && isGitHubUsernameValid(social.github)) {
|
||||
generate()
|
||||
}
|
||||
} else if (social.github) {
|
||||
if (isGithubUsernameValid(social.github)) {
|
||||
if (isGitHubUsernameValid(social.github)) {
|
||||
generate()
|
||||
}
|
||||
} else {
|
||||
@@ -416,9 +416,9 @@ const IndexPage = () => {
|
||||
|
||||
return (
|
||||
<>
|
||||
<SEO title="Github Profile Readme Generator" />
|
||||
<SEO title="GitHub Profile Readme Generator" />
|
||||
<>
|
||||
<Header heading="Github Profile README Generator" />
|
||||
<Header heading="GitHub Profile README Generator" />
|
||||
</>
|
||||
|
||||
<div className="form">
|
||||
@@ -453,9 +453,9 @@ const IndexPage = () => {
|
||||
) : (
|
||||
""
|
||||
)}
|
||||
{social.github && !isGithubUsernameValid(social.github) ? (
|
||||
{social.github && !isGitHubUsernameValid(social.github) ? (
|
||||
<div className="warning">
|
||||
* Github username is invalid, please add a valid username
|
||||
* GitHub username is invalid, please add a valid username
|
||||
</div>
|
||||
) : (
|
||||
""
|
||||
|
||||
@@ -10,7 +10,7 @@ export default function Template({
|
||||
const { frontmatter, html } = markdownRemark
|
||||
return (
|
||||
<>
|
||||
<Header heading="Github Profile README Generator" />
|
||||
<Header heading="GitHub Profile README Generator" />
|
||||
<div className="blog-post-container">
|
||||
<div className="blog-post">
|
||||
<h1>{frontmatter.title}</h1>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
const isGithubUsernameValid = (username) => {
|
||||
const isGitHubUsernameValid = (username) => {
|
||||
var pattern = /^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i
|
||||
return pattern.test(username)
|
||||
}
|
||||
@@ -9,4 +9,4 @@ const isMediumUsernameValid = (username) => {
|
||||
return true
|
||||
}
|
||||
|
||||
export { isGithubUsernameValid, isMediumUsernameValid };
|
||||
export { isGitHubUsernameValid, isMediumUsernameValid };
|
||||
|
||||
Reference in New Issue
Block a user