Skip to content

tahmid-shahriar/gatsby-source-google-docs

 
 

Repository files navigation

gatsby-source-google-docs


gatsby-source-google-docs


Npm Build Status Coverage Downloads PRs welcome MIT license


gatsby-source-google-docs is a Gatsby plugin to use Google Docs as a data source.

Why use Google Docs to write your content :

  • 🖋 Best online WYSIWYG editor
  • 🖥 Desktop web app
  • 📱 Mobile app
  • 🛩 Offline redaction
  • 🔥 No need for external CMS
  • ✅ No more content in your source code
  • 🗂 Automatic breadcrumb generation
  • 🤡 Custom metadata fields

Usage

  1. Download gatsby-source-google-docs from the NPM registry:
yarn add gatsby-source-google-docs gatsby-transformer-remark gatsby-remark-images
  1. Generate a token

The package needs 3 .env variables with the following format to work:

GOOGLE_OAUTH_CLIENT_ID=2...m.apps.googleusercontent.com
GOOGLE_OAUTH_CLIENT_SECRET=Q...axL
GOOGLE_DOCS_TOKEN={"access_token":"ya...J0","refresh_token":"1..mE","scope":"https://www.googleapis.com/auth/drive.metadata.readonly https://www.googleapis.com/auth/documents.readonly","token_type":"Bearer","expiry_date":1598284554759}

gatsby-source-google-docs expose a script to make the generation easier. Open a terminal at the root of your project and type:

gatsby-source-google-docs-token

The format changed in v2.0.0-beta.16. Check the migration guide

  1. Add the plugin in your gatsby-config.js file
module.exports = {
    plugins: [
        "gatsby-source-google-docs",
        {
            resolve: "gatsby-transformer-remark",
            options: {
                plugins: ["gatsby-remark-images"],
            },
        },
    ],
}
  1. Create pages

Showcase

You are using gatsby-source-google-docs for your website? Thank you!

Please add your website to the Showcase

Documentation

Contributing

  • ⇄ Pull/Merge requests and ★ Stars are always welcome.
  • For bugs and feature requests, please create an issue.

Changelog

See CHANGELOG

License

This project is licensed under the MIT License - see the LICENCE file for details

About

Gatsby plugin to use Google Docs as a data source

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%