Files
Chiali 88fd374af4 Update README.md
adding markdown support in readme
2023-09-18 11:46:42 -04:00
..
2023-09-08 19:34:02 +01:00
2023-09-08 19:34:02 +01:00
2023-09-08 19:34:02 +01:00
2023-09-14 14:35:46 -05:00
2023-08-17 02:53:48 +02:00
2023-08-17 02:53:48 +02:00
2023-09-12 21:57:31 -05:00
2023-09-08 19:34:02 +01:00
2023-09-14 14:35:46 -05:00
2023-08-17 02:53:48 +02:00
2023-09-08 19:34:02 +01:00
2023-09-14 14:35:46 -05:00
2023-08-17 02:53:48 +02:00
2023-09-18 11:46:42 -04:00
2023-09-12 09:27:42 +01:00
2023-09-01 12:54:06 +02:00
2023-09-08 19:34:02 +01:00
2023-09-08 19:34:02 +01:00
2023-09-08 19:34:02 +01:00
2023-09-08 19:34:02 +01:00
2023-08-17 02:53:48 +02:00
2023-09-08 19:34:02 +01:00
2023-09-14 14:35:46 -05:00
2023-08-17 16:30:15 +02:00
2023-08-17 15:31:30 +02:00
2023-09-08 19:34:02 +01:00
2023-09-14 14:35:46 -05:00
2023-09-08 19:34:02 +01:00

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
export const example: ProjectInterface = {
  id: "example",
  image: "",
  name: "This is an example of the project",
  tags: {
    keywords: [],
    themes: [],
    types: [],
    builtWith: [],
  },
}
  1. 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

export const example: ProjectInterface = {
  id: "example",
  image: "",
  name: "This is an example of the project",
  tags: {
    themes: ["play", "build"],
  },
}

This is the result

Project card badge

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.

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

Project links

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.