Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexmacarthur/gatsby-source-dropbox-paper

A source plugin for Gatsby that pulls data from the Dropbox Paper API.
https://github.com/alexmacarthur/gatsby-source-dropbox-paper

dropbox dropbox-api gatsby gatsby-plugin jamstack react

Last synced: 2 months ago
JSON representation

A source plugin for Gatsby that pulls data from the Dropbox Paper API.

Host: GitHub
URL: https://github.com/alexmacarthur/gatsby-source-dropbox-paper
Owner: alexmacarthur
License: mit
Created: 2018-12-12T13:09:37.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2022-02-12T09:07:23.000Z (almost 3 years ago)
Last Synced: 2024-10-12T02:50:10.442Z (3 months ago)
Topics: dropbox, dropbox-api, gatsby, gatsby-plugin, jamstack, react
Language: JavaScript
Homepage: https://www.gatsbyjs.org/packages/gatsby-source-dropbox-paper
Size: 60.5 KB
Stars: 24
Watchers: 4
Forks: 2
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT

Awesome Lists containing this project

README

# Dropbox Paper Source Plugin for Gatsby

Use this plugin to pull data from a [Dropbox Paper](https://paper.dropbox.com/) account into a [Gatsby](https://www.gatsbyjs.org/) site or application.

## Installation

1. Run `npm install gatsby-source-dropbox-paper`.

2. Get an access token for your Dropbox account, which can be generated [here](https://dropbox.github.io/dropbox-api-v2-explorer).

3. In your `gatsby-config.js` file, add the plugin and the access token to the `plugins` array:

```js
plugins: [
{
resolve: "gatsby-source-dropbox-paper",
options: {
access_token: "your-access-token"
}
]
```

You're all set!

## Usage

### Setting Output Format

By default, data will be pulled in Markdown format, but you may also specify "html" by including a `format` option:

```js
plugins: [
'gatsby-plugin-react-helmet',
{
resolve: "gatsby-source-dropbox-paper",
options: {
access_token: "your-access-token",
format: "html"
},
},
```

### Querying for Data

You can use the following GraphQL fields to pull raw data into your pages.

```graphql
{
allDropboxPaperDocument(limit: 10) {
edges {
node {
content
doc_id
owner
title
created_date
status {
_tag
}
revision
last_updated_date
last_editor
id
internal {
type
content
contentDigest
owner
}
}
}
}
}
```

#### Get Transformed Markdown

Using the [gatsby-transformer-remark](https://www.gatsbyjs.org/packages/gatsby-transformer-remark/) plugin, you can access pulled Markdown transformed into HTML. Simply use the `childMarkdownRemark` field when querying for data.

```graphql
{
allDropboxPaperDocument(limit: 10) {
edges {
node {
childMarkdownRemark {
id
html
excerpt
timeToRead
wordCount {
paragraphs
sentences
words
}
}
}
}
}
}
```

## The Future

Right now, this plugin pulls _all_ documents from an authenticated account, which is less than ideal. Improvements will come with changes to this plugin, as well as the evolution of the [Dropbox API](https://www.dropbox.com/developers), which has limited capabilities in terms of filtering documents to be pulled. Here's what I'd like to see in the future:

- The ability pull documents by status.
- The ability to pull documents by specific directory.
- Other stuff.

## Contributions

Please do!

## License