Skip to content
This repository has been archived by the owner on Aug 7, 2024. It is now read-only.

Adding of a Click to Copy button to the docs #2574

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions pages/docs/how-to-guides/bio.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import DocsLayout from "../../../components/layouts/DocsLayout.js";
import ClipboardCopy from "../../../components/ClipboardCopy"

## Bio

Expand All @@ -14,11 +15,13 @@ _If you need help on how to edit this file, please see the [Editing guide](/docs

2. In the `bio` string, you can wrap text in double asterix to make it bold, here is an example

<ClipboardCopy>
```js
{
"bio": "Open Source DevRel | Founder of **EddieHub** | **GitHub** Star"
}
```
</ClipboardCopy>

![LinkFree profile using markdown in bio](https://user-images.githubusercontent.com/624760/208985171-9f337433-92c6-43b7-86a4-05d6af691690.png)

Expand Down
5 changes: 5 additions & 0 deletions pages/docs/how-to-guides/links.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import DocsLayout from "../../../components/layouts/DocsLayout.js";
import ClipboardCopy from "../../../components/ClipboardCopy"

## Links

Expand All @@ -14,13 +15,15 @@ _If you need help on how to edit this file, please see the [Editing guide](/docs

This is an example of a single link object:

<ClipboardCopy>
```js
{
"name": "Follow me on Twitter",
"url": "https://twitter.com/SaraJaoude",
"icon": "FaTwitter"
}
```
</ClipboardCopy>

| field | type | description |
| :---- | :----- | :--------------------------------------------------------------------------------------------------------- |
Expand All @@ -30,6 +33,7 @@ This is an example of a single link object:

To add more links add another object inside the links collection. For example:

<ClipboardCopy>
```js
"links": [
{
Expand All @@ -44,6 +48,7 @@ To add more links add another object inside the links collection. For example:
}
]
```
</ClipboardCopy>

3. Now you can commit your file and create a Pull Request, for more details please see [Editing guide](/docs/how-to-guides/editing)

Expand Down
5 changes: 5 additions & 0 deletions pages/docs/how-to-guides/milestones.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import DocsLayout from "../../../components/layouts/DocsLayout.js";
import ClipboardCopy from "../../../components/ClipboardCopy"

## Milestones

Expand All @@ -14,6 +15,7 @@ _If you need help on how to edit this file, please see the [Editing guide](/docs

2. Add a collection called `milestones` at the root of your `json` file which will contain one or more social objects. Each social object must have six fields, `title`, `date`, `icon`, `color`, `description` and `url`, which will look like this:

<ClipboardCopy>
```js
{
"title": "Started Freelancing",
Expand All @@ -24,6 +26,7 @@ _If you need help on how to edit this file, please see the [Editing guide](/docs
"url": "https://www.eddiejaoude.io/"
}
```
</ClipboardCopy>

| Property | Description |
| :---------- | :---------------------------------------------------------- |
Expand All @@ -36,6 +39,7 @@ _If you need help on how to edit this file, please see the [Editing guide](/docs

This is what a complete example looks like:

<ClipboardCopy>
```js
"milestones": [
{
Expand All @@ -48,6 +52,7 @@ This is what a complete example looks like:
}
]
```
</ClipboardCopy>

3. Now you can commit your file and create a Pull Request, for more details please see [Editing guide](/docs/how-to-guides/editing)

Expand Down
5 changes: 5 additions & 0 deletions pages/docs/how-to-guides/socials-shortcuts.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import DocsLayout from "../../../components/layouts/DocsLayout.js";
import ClipboardCopy from "../../../components/ClipboardCopy"

## Social shortcuts

Expand All @@ -14,22 +15,26 @@ _If you need help on how to edit this file, please see the [Editing guide](/docs

2. Add a collection called `socials` at the root of your json file which will contain one or more social objects. Each social object must have two fields, `platform` and `url`, which will look like this:

<ClipboardCopy>
```js
{
"icon": "FaTwitter",
"url": "https://twitter.com/eddiejaoude"
}
```
</ClipboardCopy>

This is what a complete example looks like:

<ClipboardCopy>
```js
"socials": [
{ "icon": "FaTwitter", "url": "https://twitter.com/eddiejaoude" },
{ "icon": "FaGithub", "url": "https://github.com/eddiejaoude" },
{ "icon": "FaYoutube", "url": "https://youtube.com/eddiejaoude" }
]
```
</ClipboardCopy>

3. Now you can commit your file and create a Pull Request, for more details please see [Editing guide](/docs/how-to-guides/editing)

Expand Down
3 changes: 3 additions & 0 deletions pages/docs/how-to-guides/statistics.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import DocsLayout from "../../../components/layouts/DocsLayout.js";
import ClipboardCopy from "../../../components/ClipboardCopy"

## Statistics

Expand All @@ -16,6 +17,7 @@ _If you need help on how to edit this file, please see the [Editing guide](/docs

2. Add another field under your name that is `displayStatsPublic` this will need the value `true` and it should look like this:

<ClipboardCopy>
```js
{
"name": "Sara Jaoude",
Expand All @@ -25,6 +27,7 @@ _If you need help on how to edit this file, please see the [Editing guide](/docs
"avatar": "https://github.com/SaraJaoude.png",
}
```
</ClipboardCopy>

3. Now you can commit your file and create a Pull Request, for more details please see [Editing guide](/docs/how-to-guides/editing)

Expand Down
3 changes: 3 additions & 0 deletions pages/docs/how-to-guides/tags.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import DocsLayout from "../../../components/layouts/DocsLayout.js";
import ClipboardCopy from "../../../components/ClipboardCopy"

## Tags

Expand All @@ -16,6 +17,7 @@ _If you need help on how to edit this file, please see the [Editing guide](/docs

This is what an example looks like:

<ClipboardCopy>
```js
"tags": [
"Open Source",
Expand All @@ -26,6 +28,7 @@ This is what an example looks like:
"DevRel"
]
```
</ClipboardCopy>

3. Now you can commit your file and create a Pull Request, for more details please see [Editing guide](/docs/how-to-guides/editing)

Expand Down
5 changes: 5 additions & 0 deletions pages/docs/how-to-guides/testimonials.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import DocsLayout from "../../../components/layouts/DocsLayout.js";
import ClipboardCopy from "../../../components/ClipboardCopy"

## Testimonials

Expand All @@ -12,20 +13,23 @@ You can give a Testimonial for another LinkFree user by submitting an issue http

Also you can add a Testimonial manually by creating the `json` file `data/<username>/testimonials/<your-username>.json` with the content:

<ClipboardCopy>
```js
{
"title": "Founder of an Amazing Community",
"description": "Eddie founded EddieHub, an opensource community, which aparked my interest in all things FOSS and FOSH. Eddie's YouTube videos are also inspiring, especially the livestreams, where one can really see the community come together. My number one reccommendation to anyone who's starting thier opensource jouney :sparkles:",
"date": "2022-26-11"
}
```
</ClipboardCopy>

### Including a Testimonial on your Profile

If you receive a Testimonials, you can include this in the Testimonial section of your Profile.

You can do this by including the usernames of the testimonials you wish to show on your profile with the following `json` code:

<ClipboardCopy>
```js
"testimonials": [
"CBID2",
Expand All @@ -34,6 +38,7 @@ You can do this by including the usernames of the testimonials you wish to show
"krupalitrivedi"
]
```
</ClipboardCopy>

export default ({ children }) => (
<DocsLayout title="LinkFree Testimonials Documentation">
Expand Down