mirror of
https://github.com/privacy-scaling-explorations/pse.dev.git
synced 2026-01-14 08:38:02 -05:00
85 lines
2.1 KiB
Markdown
85 lines
2.1 KiB
Markdown
## Add new project to projects list
|
|
|
|
1. Add new file inside `[...]/data/projects.ts` folder
|
|
2. Add project details inside the file already created, to easily include all the required parameters make sure to use the `ProjectInterface`
|
|
|
|
```js
|
|
export const example: ProjectInterface = {
|
|
id: "example",
|
|
image: "",
|
|
name: "This is an example of the project",
|
|
tags: {
|
|
keywords: [],
|
|
themes: [],
|
|
types: [],
|
|
builtWith: [],
|
|
},
|
|
}
|
|
```
|
|
|
|
3. Include the exported constant of the project in `projects.ts`
|
|
|
|
## Show badges in the project card
|
|
|
|
Badges can be set by setting the `themes` params, by looking at this example
|
|
|
|
```js
|
|
export const example: ProjectInterface = {
|
|
id: "example",
|
|
image: "",
|
|
name: "This is an example of the project",
|
|
tags: {
|
|
themes: ["play", "build"],
|
|
},
|
|
}
|
|
```
|
|
|
|
This is the result
|
|
|
|
|
|
|
|
## Show links in project page detail
|
|
|
|
To add extra link to projects we need to add `extraLinks` for the projects we are going to add links for.
|
|
Make sure that for every "themes" value there is a specific "extraLinks" object will all the links.
|
|
|
|
```js
|
|
export const example: ProjectInterface = {
|
|
id: "example",
|
|
image: "",
|
|
name: "This is an example of the project",
|
|
tldr: 'The project one-liner',
|
|
description: 'A longer project description',
|
|
projectStatus: '',
|
|
tags: {
|
|
themes: ["play", "buildWith"],
|
|
keywords: ["Anonymity/privacy", "Voting/governance"],
|
|
types: ["Lego sets/toolkits", "Infrastructure/protocol"],
|
|
builtWith: ["p0tion", "JubjubLib"],
|
|
},
|
|
extraLinks: {
|
|
buildWith: [
|
|
{
|
|
label: "Link to get started",
|
|
url: 'https://google.it"',
|
|
},
|
|
],
|
|
play: [
|
|
{
|
|
label: "Link to get started",
|
|
url: 'https://google.it"',
|
|
},
|
|
],
|
|
},
|
|
}
|
|
```
|
|
|
|
This is the result
|
|
|
|
|
|
|
|
## Markdown supported
|
|
|
|
You can also format the description to your liking using markdown. We supported all the heading, bold and table.
|
|
This can help the reader to quickly scan through the important information.
|