diff --git a/components/BreadCrumb.js b/components/BreadCrumb.js new file mode 100644 index 00000000000..2ee7eb94e5e --- /dev/null +++ b/components/BreadCrumb.js @@ -0,0 +1,55 @@ +import { FiChevronRight } from "react-icons/fi"; +import { AiOutlineHome } from "react-icons/ai"; + +import Link from "@components/Link"; + +export default function BreadCrumb({ section, name }) { + return ( + + ); +} diff --git a/components/layouts/DocsLayout.js b/components/layouts/DocsLayout.js index 865c0b81198..0d10d247327 100644 --- a/components/layouts/DocsLayout.js +++ b/components/layouts/DocsLayout.js @@ -4,8 +4,9 @@ import Head from "next/head"; import Page from "@components/Page"; import Link from "@components/Link"; import { ComponentStyle } from "@components/mdx/ComponentStyle"; +import BreadCrumb from "@components/BreadCrumb"; -export default function DocsLayout({ children, title }) { +export default function DocsLayout({ children, title, section, name }) { return ( <> @@ -17,6 +18,7 @@ export default function DocsLayout({ children, title }) { +

Documentation

Here you should find everything you need from getting started with diff --git a/pages/docs/advanced/single-user-mode.mdx b/pages/docs/advanced/single-user-mode.mdx index a7701405764..85c428fd530 100644 --- a/pages/docs/advanced/single-user-mode.mdx +++ b/pages/docs/advanced/single-user-mode.mdx @@ -19,7 +19,11 @@ This allows you to host LinkFree yourself for your single Profile, but this will 3. Host the app on your favourite platform export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/community-resources.mdx b/pages/docs/community-resources.mdx index bb959fd8ffe..c45555992d0 100644 --- a/pages/docs/community-resources.mdx +++ b/pages/docs/community-resources.mdx @@ -27,12 +27,18 @@ YouTube (or blog) | [Jaynarayan vaishnav](https://github.com/jaynarayan-vaishnav) | Pair programmed on Discord | 2022/10/31 | [#2079](https://github.com/EddieHubCommunity/LinkFree/pull/2080) | | [Bilal Khan](https://github.com/ibilalkayy) | YouTube | 2023/01/18 | [Submitting My First PR with Dean - LinkFree Account Creation for Beginners](https://www.youtube.com/watch?v=I8wNateK3hM) | | [Bilal Khan](https://github.com/ibilalkayy) | Blog | 2023/01/21 | [How to create a LinkFree account? [Part 1]](https://ibilalkayy.hashnode.dev/how-to-create-a-linkfree-account-part-1) | -| [Ananya Nayak](https://github.com/Ananya2001-an) | Blog | 2023/02/05 | [Ananya in Open Source Wonderland](https://ananyacodes.hashnode.dev/ananya-in-open-source-wonderland) +| [Ananya Nayak](https://github.com/Ananya2001-an) | Blog | 2023/02/05 | [Ananya in Open Source Wonderland](https://ananyacodes.hashnode.dev/ananya-in-open-source-wonderland) | | [Rohit](https://github.com/TRohit20) | Blog | 2023/03/01 | [Beyond Code: How Anyone Can Contribute to Open-Source Projects](https://rohitlogs.com/beyond-code-how-anyone-can-contribute-to-open-source-projects) | | [Madhu Saini](https://github.com/MadhuSaini22) | Blog | 2023/03/12 | [Beyond Code: A Beginner's Guide to Open Source](https://madhusaini22.hashnode.dev/a-beginners-guide-to-open-source) | -| [Amanda Martin](https://github.com/amandamartin-dev) | Livestream | 2023/03/16 | [Combining the roles of Developer Advocate and Open Source Ambassador](https://stack-stream.com/v/combining-the-roles-of-developer-advocate-and-open-source-ambassador) | -| [Ananya Nayak](https://github.com/Ananya2001-an) | Blog | 2023/03/28 | [How to understand a big codebase???](https://ananyacodes.hashnode.dev/how-to-understand-a-big-codebase) +| [Amanda Martin](https://github.com/amandamartin-dev) | Livestream | 2023/03/16 | [Combining the roles of Developer Advocate and Open Source Ambassador](https://stack-stream.com/v/combining-the-roles-of-developer-advocate-and-open-source-ambassador) | +| [Ananya Nayak](https://github.com/Ananya2001-an) | Blog | 2023/03/28 | [How to understand a big codebase???](https://ananyacodes.hashnode.dev/how-to-understand-a-big-codebase) | export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/contributing/automated-tests.mdx b/pages/docs/contributing/automated-tests.mdx index 7abb29d96e2..bae41b1ef2a 100644 --- a/pages/docs/contributing/automated-tests.mdx +++ b/pages/docs/contributing/automated-tests.mdx @@ -33,7 +33,11 @@ To open last HTML report run: ``` export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/contributing/commits.mdx b/pages/docs/contributing/commits.mdx index 202145324ad..3c4c0de7c67 100644 --- a/pages/docs/contributing/commits.mdx +++ b/pages/docs/contributing/commits.mdx @@ -50,7 +50,11 @@ test: profile tag redirect (#1234) Learn more about Conventional Commits export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/contributing/hacktoberfest.mdx b/pages/docs/contributing/hacktoberfest.mdx index ada1aa46275..f03cd17eee1 100644 --- a/pages/docs/contributing/hacktoberfest.mdx +++ b/pages/docs/contributing/hacktoberfest.mdx @@ -15,7 +15,11 @@ Pull requests which add or edit your information in a `data/` file WILL NOT be c Pull requests which improve the codebase, documentation, or other aspects of the project and are in line with the core values of the event WILL count. The project contains the Hacktoberfest topic, so the PRs will automatically BE counted towards Hacktoberfest. However, Profile update PRs will have the label `invalid` and therefore won't be counted towards this event. export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/contributing/labels.mdx b/pages/docs/contributing/labels.mdx index d319543e8a5..53b3c299746 100644 --- a/pages/docs/contributing/labels.mdx +++ b/pages/docs/contributing/labels.mdx @@ -39,7 +39,11 @@ The maintainers do not want anyone working on this issue yet. For example it mig You can request to be assigned this issue, then you can start working on it. Please do not tag a specific person to assign, as all maintainers will be notified of the repo activity. export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/contributing/reviewers.mdx b/pages/docs/contributing/reviewers.mdx index 4110f4e21c9..96af80a7cc9 100644 --- a/pages/docs/contributing/reviewers.mdx +++ b/pages/docs/contributing/reviewers.mdx @@ -99,5 +99,11 @@ The exception is if the changes have made modifications to the `package.json` fi If the author needs help undoing their changes to the lock file, I have created a video on how they can achieve this https://www.youtube.com/watch?v=jHkIXYVpMTo export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/contributing/storybook.mdx b/pages/docs/contributing/storybook.mdx index fa1961e5405..c3f4e3d99d1 100644 --- a/pages/docs/contributing/storybook.mdx +++ b/pages/docs/contributing/storybook.mdx @@ -22,5 +22,11 @@ _note: not all components have been added, this is a great way to contribute to 1. Run `npm run storybook` to see the added components and visit `http://localhost:6006` to interact with them in the browser export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/docs-style-guide.mdx b/pages/docs/docs-style-guide.mdx index a7c7e271fcc..39bd7bb262b 100644 --- a/pages/docs/docs-style-guide.mdx +++ b/pages/docs/docs-style-guide.mdx @@ -71,5 +71,11 @@ For example: - **Use this:** There are **4** ways you can run the project export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/environments/environment-variables.mdx b/pages/docs/environments/environment-variables.mdx index 49a54f91600..d6760bbd592 100644 --- a/pages/docs/environments/environment-variables.mdx +++ b/pages/docs/environments/environment-variables.mdx @@ -3,7 +3,7 @@ import Link from "@components/Link"; ## Environment variables -Environment variables are needed in the `.env` file to allow the application to run correctly. `.env.example` file has an example template you can use to get started. However, you will need to follow these steps to get your GitHub OAuth environment variables. Please note that if you are working in Gitpod and wish to access authenticated pages, you will need to complete these steps each time with the URL Gitpod generates for your dev environment as localhost will not work. To avoid this, you may choose to work in Docker which only requires this setup once. +Environment variables are needed in the `.env` file to allow the application to run correctly. `.env.example` file has an example template you can use to get started. However, you will need to follow these steps to get your GitHub OAuth environment variables. Please note that if you are working in Gitpod and wish to access authenticated pages, you will need to complete these steps each time with the URL Gitpod generates for your dev environment as localhost will not work. To avoid this, you may choose to work in Docker which only requires this setup once. | variable | example | required | description | | :------------------------------- | :--------------------------------- | :------- | :-------------------------------------------------- | @@ -21,19 +21,23 @@ Environment variables are needed in the `.env` file to allow the application to 2. Then `Developer settings` down the bottom left 3. Click `New OAuth app` and fill in the form details -| Form field | value | -| :------------------------- | :----------------------------------------------- | -| Application name | `LinkFree local` | -| Homepage URL | `https://linkfree.io` | -| Application description | `LinkFree allows you to connect with your audience using a single link.`| -| Authorization callback URL | `http://localhost:3000/api/auth/callback/github` | +| Form field | value | +| :------------------------- | :----------------------------------------------------------------------- | +| Application name | `LinkFree local` | +| Homepage URL | `https://linkfree.io` | +| Application description | `LinkFree allows you to connect with your audience using a single link.` | +| Authorization callback URL | `http://localhost:3000/api/auth/callback/github` | Then use the generated **Client ID** and **Client Secret** in the `.env`. Full details on GitHub docs https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/environments/github-ui.mdx b/pages/docs/environments/github-ui.mdx index 2f23009ba81..e97f27c3227 100644 --- a/pages/docs/environments/github-ui.mdx +++ b/pages/docs/environments/github-ui.mdx @@ -9,7 +9,11 @@ Please refer to the following guides that use the GitHub UI to create and edit P - Editing export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/environments/gitpod.mdx b/pages/docs/environments/gitpod.mdx index 4c36b251e1f..343b48b91ab 100644 --- a/pages/docs/environments/gitpod.mdx +++ b/pages/docs/environments/gitpod.mdx @@ -6,7 +6,7 @@ Gitpod is an open-source application that provides a prebuilt development enviro ### How to use Gitpod -You can use Gitpod in the cloud. Please note, that Gitpod requires additional configuration to work on the authenticated pages in LinkFree. See instructions for [how to set up your OAuth app](/docs/environments/environment-variables) for more information. +You can use Gitpod in the cloud. Please note, that Gitpod requires additional configuration to work on the authenticated pages in LinkFree. See instructions for [how to set up your OAuth app](/docs/environments/environment-variables) for more information. There are 2 ways you can open a repository with Gitpod: @@ -17,7 +17,7 @@ There are 2 ways you can open a repository with Gitpod: Once you have opened a repository, you can develop as you usually do! In the next example, we will update our profile from LinkFree. -**_NOTES:_** +**_NOTES:_** 1. Be sure that you have a fork of LinkFree in your Github Profile. If you don't have it, check out the [Quickstart Guide](https://linkfree.io/docs/quickstart). @@ -69,7 +69,11 @@ If you encounter permission issues, follow the next steps: [![Open LinkFree on Gitpod](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/EddieHubCommunity/LinkFree) export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/environments/linkfree-cli.mdx b/pages/docs/environments/linkfree-cli.mdx index fa32ba3cd96..8f43e6bbfbb 100644 --- a/pages/docs/environments/linkfree-cli.mdx +++ b/pages/docs/environments/linkfree-cli.mdx @@ -42,5 +42,11 @@ npm run cli If you find any kind of bug you can use the 5th option `🐛 Report a bug` in the main prompt to report the bug. You can also create an issue in the [LinkFree CLI](https://github.com/Pradumnasaraf/LinkFree-CLI/issues/new?assignees=&labels=bug&template=bug.yaml) repository. export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/environments/local-development.mdx b/pages/docs/environments/local-development.mdx index 234333623b8..90edc83505a 100644 --- a/pages/docs/environments/local-development.mdx +++ b/pages/docs/environments/local-development.mdx @@ -70,7 +70,11 @@ docker compose down If you are getting an error, try to rebuild the images with `docker compose up --build`. If that doesn't work, stop the containers with `docker compose down` and remove the stopped linkfree container with `docker rm linkfree`. Then, remove the images with `docker rmi linkfree-app`. Lastly, rebuild the images with `docker compose up --build`. export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/environments/local-with-atlas.mdx b/pages/docs/environments/local-with-atlas.mdx index ac7025fc23e..d2f2f3d7b83 100644 --- a/pages/docs/environments/local-with-atlas.mdx +++ b/pages/docs/environments/local-with-atlas.mdx @@ -50,7 +50,11 @@ Remember to replace password in the connection string with the password you set That's it! You have successfully set up a MongoDB Atlas database and it's now ready for use in your LinkFree local development environment. export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/faqs.mdx b/pages/docs/faqs.mdx index 9da4bfcf87b..e49882fdd7c 100644 --- a/pages/docs/faqs.mdx +++ b/pages/docs/faqs.mdx @@ -24,5 +24,7 @@ Once your Pull Request is merged it is deployed automatically. The deployment ca If your Profile is not visible after merging, please contact the maintainers in EddieHub Discord or in the GitHub Discussions in the LinkFree repo. export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/full-profile-example.mdx b/pages/docs/full-profile-example.mdx index f549361aada..20b59d99eca 100644 --- a/pages/docs/full-profile-example.mdx +++ b/pages/docs/full-profile-example.mdx @@ -152,7 +152,11 @@ _Note: the data fields `links`, `milestones`, `testimonials`, `tags`, `socials` Click on the relevant section to learn more about Events and Testimonials. export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/how-to-guides/bio.mdx b/pages/docs/how-to-guides/bio.mdx index a39e8330f67..ad19165a6d7 100644 --- a/pages/docs/how-to-guides/bio.mdx +++ b/pages/docs/how-to-guides/bio.mdx @@ -31,5 +31,11 @@ _If you need help on how to edit this file, please see the {children} + + {children} + ); diff --git a/pages/docs/how-to-guides/editing.mdx b/pages/docs/how-to-guides/editing.mdx index 58676001091..17735221a12 100644 --- a/pages/docs/how-to-guides/editing.mdx +++ b/pages/docs/how-to-guides/editing.mdx @@ -103,7 +103,11 @@ To make further changes to an open Pull Request, follow these steps: GitHub will automatically append these changes to your open Pull Request. export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/how-to-guides/events.mdx b/pages/docs/how-to-guides/events.mdx index 7d8d6851b7f..e0f90f3a1d3 100644 --- a/pages/docs/how-to-guides/events.mdx +++ b/pages/docs/how-to-guides/events.mdx @@ -77,7 +77,11 @@ _If you need help on how to edit this file, please see the {children} + + {children} + ); - -; diff --git a/pages/docs/how-to-guides/links.mdx b/pages/docs/how-to-guides/links.mdx index 58667ce0280..045b6163b21 100644 --- a/pages/docs/how-to-guides/links.mdx +++ b/pages/docs/how-to-guides/links.mdx @@ -61,5 +61,11 @@ _Clicks on these social shortcuts that match any of your links will also increme ![LinkFree profile with grouped links](https://user-images.githubusercontent.com/624760/214538171-099cac71-d2f7-49a8-b3bb-2747506a1bac.png) export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/how-to-guides/milestones.mdx b/pages/docs/how-to-guides/milestones.mdx index 1badd592756..c153c5108d4 100644 --- a/pages/docs/how-to-guides/milestones.mdx +++ b/pages/docs/how-to-guides/milestones.mdx @@ -59,5 +59,11 @@ This is what a complete example looks like: 3. Now you can commit your file and create a Pull Request, for more details please see Editing Guide export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/how-to-guides/socials-shortcuts.mdx b/pages/docs/how-to-guides/socials-shortcuts.mdx index fda6e6d3286..61bf403df8f 100644 --- a/pages/docs/how-to-guides/socials-shortcuts.mdx +++ b/pages/docs/how-to-guides/socials-shortcuts.mdx @@ -46,7 +46,11 @@ The icon you would like displayed. We support the following icon sets: **Fa** an _Clicks on these social shortcuts that match any of your links will also increment their respective counters_ export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/how-to-guides/statistics.mdx b/pages/docs/how-to-guides/statistics.mdx index d5098a67d83..5e6530688e8 100644 --- a/pages/docs/how-to-guides/statistics.mdx +++ b/pages/docs/how-to-guides/statistics.mdx @@ -9,5 +9,11 @@ You can view statistics by logging into LinkFree with your GitHub account. ![Private account page](https://user-images.githubusercontent.com/624760/217878006-469119bf-aa9c-4788-963e-0bbe70477a47.jpeg) export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/how-to-guides/tags.mdx b/pages/docs/how-to-guides/tags.mdx index a2e4ddf005d..b30303ee0c2 100644 --- a/pages/docs/how-to-guides/tags.mdx +++ b/pages/docs/how-to-guides/tags.mdx @@ -32,5 +32,11 @@ This is what an example looks like: _Clicks on these social shortcuts that match any of your links will also increment their respective counters_ export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/how-to-guides/testimonials.mdx b/pages/docs/how-to-guides/testimonials.mdx index 6929a0c00b8..966bd496d82 100644 --- a/pages/docs/how-to-guides/testimonials.mdx +++ b/pages/docs/how-to-guides/testimonials.mdx @@ -48,7 +48,11 @@ You can do this by including the usernames of the testimonials you wish to show ``` export default ({ children }) => ( - + {children} ); diff --git a/pages/docs/index.js b/pages/docs/index.js index 5361054b060..b6e8b0719ff 100644 --- a/pages/docs/index.js +++ b/pages/docs/index.js @@ -265,10 +265,11 @@ export default function DocsIndex() { { name: "Docs Style Guide", path: "/docs/docs-style-guide", - description: "A guide for contributors when making changes to the documentation.", + description: + "A guide for contributors when making changes to the documentation.", category: { - name: "Beginner", - color: "bg-green-100 text-green-800", + name: "Beginner", + color: "bg-green-100 text-green-800", }, }, ], @@ -280,12 +281,11 @@ export default function DocsIndex() { { name: "Profile Tips", path: "/docs/profile-tips", - description: - "Tips on making your LinkFree profile stand out.", - category: { + description: "Tips on making your LinkFree profile stand out.", + category: { name: "Beginner", color: "bg-green-100 text-green-800", - } + }, }, { name: "Full Profile Example", @@ -374,7 +374,10 @@ export default function DocsIndex() { >

-

+

{section.title}

diff --git a/pages/docs/maintainers.mdx b/pages/docs/maintainers.mdx index 8d129016054..ea919f369e8 100644 --- a/pages/docs/maintainers.mdx +++ b/pages/docs/maintainers.mdx @@ -87,5 +87,7 @@ At the time, we have chosen not to have a specific duration for the role, howeve - [Reviewers Docs](/docs/contributing/reviewers) export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/map.mdx b/pages/docs/map.mdx index 084ac2a0ef9..1592f296af2 100644 --- a/pages/docs/map.mdx +++ b/pages/docs/map.mdx @@ -33,5 +33,11 @@ You can find the relevant code that retrieves the location information for each Note: This situation only affects the local development environment and not the production environment. In production, the user markers will appear on the map since the location information of all users is already available in the database. export default ({ children }) => ( - {children} + + {children} + ); diff --git a/pages/docs/profile-tips.mdx b/pages/docs/profile-tips.mdx index b0809c5e998..46ce9d870d1 100644 --- a/pages/docs/profile-tips.mdx +++ b/pages/docs/profile-tips.mdx @@ -27,6 +27,7 @@ Make your LinkFree Profile stand out by following these tips. For example profiles and how to implement these tips in your Profile, visit the end section in the [QuickStart guide](/docs/quickstart#example-profiles) export default ({ children }) => ( - {children} + + {children} + ); - diff --git a/pages/docs/quickstart.mdx b/pages/docs/quickstart.mdx index ab0cdf13b95..2893f93b482 100644 --- a/pages/docs/quickstart.mdx +++ b/pages/docs/quickstart.mdx @@ -177,5 +177,11 @@ Looking for inspiration? You can view the following profiles for an example: - Add testimonials to your profile export default ({ children }) => ( - {children} + + {children} + );