fix: resolved getting started documentation (#100)

* fix: resolved 404 not found * chore: confined auto links for only h1 & h2 tags * chore: minor changes
pbclife · Mar 19, 2023 · 3165787 · 3165787 · vercel · Mar 19, 2023
1 parent 855f029
commit 3165787
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 10 deletions.
diff --git a/docs/guides/starting-contribution/getting-started.mdx b/docs/guides/starting-contribution/getting-started.mdx
@@ -11,7 +11,7 @@ There are 2 ways you can add your profile :
 
 ## Step 1:
 
-### 1. Visit the <Link href="https://github.com/pbclife/gitopener.vercel.app">GitOpener repo</Link>
+### 1. Visit the [GitOpener repo](https://github.com/pbclife/gitopener.vercel.app)
 
 ![repo](https://user-images.githubusercontent.com/95094057/218765545-f6586a18-c194-42d5-a5aa-45cf42e5b5ee.png)
 
@@ -23,12 +23,13 @@ There are 2 ways you can add your profile :
 
 ![addFile](https://user-images.githubusercontent.com/95094057/218765622-86d41908-343d-403f-891e-4a8e0b035ce3.png)
 
-### 4. Create your file named `contribution/<Your GitHub username>`, and append `.mdx` (for example `contribution/Aadarsh805.mdx`)
+### 4. Create your file named `contribution/<Your GitHub username>`, and append `.mdx` for example `contribution/Aadarsh805.mdx`
 
 ![createProfile](https://user-images.githubusercontent.com/95094057/218765648-f408a8f0-efa3-4c81-97c9-810db37f7235.png)
 
 ### 5. For the content use the mdx structure below:
-```
+
+```markdown github_username.mdx
 ---
 author: Aadarsh Thakur
 github_username: Aadarsh805
@@ -60,8 +61,6 @@ I love building cool projects, contributing to OpenSource and getting involved i
 
 ### 6. Add Projects
 
-<!-- -->
-
 ### 7. Click `Create pull request`
 
 ### 8. Now you need to wait to have your Pull Request reviewed
@@ -70,6 +69,6 @@ I love building cool projects, contributing to OpenSource and getting involved i
 
 Looking for inspiration? You can view the following profiles for an example:
 
-- ![Sagar Bera](https://gitopener.vercel.app/contribution/sboy99)
+- [Sagar Bera](https://gitopener.vercel.app/contribution/sboy99)
 
-- ![Aadarsh Thakur](https://gitopener.vercel.app/contribution/Aadarsh805)
+- [Aadarsh Thakur](https://gitopener.vercel.app/contribution/Aadarsh805)
diff --git a/src/components/contributorProfilePage/Skills.tsx b/src/components/contributorProfilePage/Skills.tsx
@@ -10,7 +10,7 @@ const Skills: FC<SkillsProps> = ({ children, title, desc }) => {
   return (
     <>
       {title && (
-        <div className="prose mb-4 max-w-lg ">
+        <div className="prose my-4 mb-4 max-w-lg">
           <h3>{title}</h3>
           {desc && <p>{desc}</p>}
         </div>

diff --git a/src/components/contributorProfilePage/Socials.tsx b/src/components/contributorProfilePage/Socials.tsx
@@ -125,7 +125,7 @@ function arrangeSocialLinks(
 
       if (tLink) {
         tLink.to = social[link] as string;
-        if (featuredLinks.length <= 2) featuredLinks.push(tLink);
+        if (featuredLinks.length < 3) featuredLinks.push(tLink);
         else otherLinks.push(tLink);
       }
       count++;

diff --git a/src/lib/mdx/getMdxContent.ts b/src/lib/mdx/getMdxContent.ts
@@ -27,7 +27,7 @@ export const getMdxContent = async (
         rehypePrism,
         rehypeSlug,
         ...rehypePlugins,
-        [rehypeAutolinkHeadings, { behavior: `wrap` }],
+        [rehypeAutolinkHeadings, { behavior: `wrap`, test: ['h1', 'h2'] }],
       ],
     },
   });