Skip to main content
Community Plugin
View plugin on GitHub
See starters using this

gatsby-source-trello-board

Source plugin for pulling data into Gatsby from a Trello board.

Install

 npm install --save gatsby-source-trello-board

How to use

In your gatsby-config.js :

{
  resolve: `gatsby-source-trello-board`,
  options: {
    key: `<your Trello key>`,
    token: `<your Trello token>`,
    board_id: `<your Trello Board id>`,
  }
}

Dont forget to use Environment Variables if you want to keep your key and token private.

How to query

Gatsby-source-trello-board will fetch information of each card of the board :

  • list_index: list position in the board
  • list_id: id of the list
  • list_slug: name of the list slugified
  • list_name: name of the list
  • index: card position in the board
  • id: id of the list
  • slug: name of the card slugified
  • name: name of the card
{
  allTrelloCard(
    filter: { list_name: { eq: "Name of the list" } }
    sort: { fields: [index], order: ASC }
  ) {
    edges {
      node {
        list_index
        list_id
        list_slug
        list_name
        index
        id
        slug
        name
        content
      }
    }
  }
}

You also can write markdown in Description, it supports gatsby-transformer-remark.

{
  trelloCard(name: { eq: "Name of the card" }) {
    childMarkdownRemark {
      excerpt
      frontmatter {
        title
      }
      html
    }
  }
}

Card’s attachments are downloaded so gatsby-image can be used.

  • childrenCardMedia: Array of card’s attachments
{
  trelloCard(name: { eq: "Name of the card" }) {
    childrenCardMedia {
      id
      name
      localFile {
        childImageSharp {
          fluid
        }
      }
    }
  }
}