Code Monkey home page Code Monkey logo

gatsby-source-dropbox's Introduction

gatsby-source-dropbox npm version

Source plugin for getting data from Dropbox account.

Install

npm install --save gatsby-source-dropbox

How to use

Configure the plugin

// In your gatsby-config.js
plugins: [
  {
    resolve: `gatsby-source-dropbox`,
    options: {
      accessToken: `access-token`,
      extensions: ['.pdf', '.jpg', '.png', '.md'],
      path: '/path/to/folder',
      recursive: false,
    },
  },
]

Options

  • accessToken: the token to use for querying dropbox. In order to get an access token you will need to create an app https://www.dropbox.com/developers/apps and generate one.
  • extensions: list of extensions used to filter out results
  • path: the folder to use to retrieve data. Defaults to '' which is the root of the dropbox project.
  • recursive: use this to retrieve files from subdirectories as well

How to query

The plugin provides some basic information of the remote files such as:

  • name the filename,
  • path the file path,
  • lastModified the last modification date,

The plugin makes use of the create remote node API of gatsby to locally download all the files in order to use them with other transformer plugins such as gatsby-transformer-sharp for images or gatsby-transformer-remark for markdown files.

Example:

query {
  allDropboxNode {
    edges {
      node {
        id
        name
        lastModified
        path
        localFile {
          childMarkdownRemark {
            html
          }
        }
      }
    }
  }
}

gatsby-source-dropbox's People

Contributors

oorestisime avatar

Watchers

Arthur Puyou avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.