{"id":31844844,"url":"https://github.com/houkasaurusrex/dropbox-paper-cms","last_synced_at":"2025-10-12T07:52:09.559Z","repository":{"id":40746923,"uuid":"189834255","full_name":"HoukasaurusRex/dropbox-paper-cms","owner":"HoukasaurusRex","description":"Using Dropbox Paper APIs to generate static content in Vuepress","archived":false,"fork":false,"pushed_at":"2022-11-09T08:10:24.000Z","size":1429,"stargazers_count":11,"open_issues_count":4,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-21T19:58:44.058Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://houkasaurusrex.github.io/dropbox-paper-cms/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HoukasaurusRex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["HoukasaurusRex"],"patreon":"TerminallyChillSoftware","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-06-02T10:44:01.000Z","updated_at":"2022-04-28T00:39:52.000Z","dependencies_parsed_at":"2023-01-21T06:45:14.856Z","dependency_job_id":null,"html_url":"https://github.com/HoukasaurusRex/dropbox-paper-cms","commit_stats":null,"previous_names":["pterobyte/dropbox-paper-cms"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/HoukasaurusRex/dropbox-paper-cms","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HoukasaurusRex%2Fdropbox-paper-cms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HoukasaurusRex%2Fdropbox-paper-cms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HoukasaurusRex%2Fdropbox-paper-cms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HoukasaurusRex%2Fdropbox-paper-cms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HoukasaurusRex","download_url":"https://codeload.github.com/HoukasaurusRex/dropbox-paper-cms/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HoukasaurusRex%2Fdropbox-paper-cms/sbom","scorecard":{"id":63332,"data":{"date":"2025-08-11","repo":{"name":"github.com/HoukasaurusRex/dropbox-paper-cms","commit":"de38ba7bf62fe4d5b5d0ebdfd52354b1f1f0c1ec"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/npm-publish.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/14 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":6,"reason":"dependency not pinned by hash detected -- score normalized to 6","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/HoukasaurusRex/dropbox-paper-cms/npm-publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/HoukasaurusRex/dropbox-paper-cms/npm-publish.yml/master?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 16 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"18 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-15T02:08:59.393Z","repository_id":40746923,"created_at":"2025-08-15T02:08:59.393Z","updated_at":"2025-08-15T02:08:59.393Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279010667,"owners_count":26084785,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-12T07:52:04.162Z","updated_at":"2025-10-12T07:52:09.551Z","avatar_url":"https://github.com/HoukasaurusRex.png","language":"JavaScript","funding_links":["https://github.com/sponsors/HoukasaurusRex","https://patreon.com/TerminallyChillSoftware"],"categories":[],"sub_categories":[],"readme":"# Dropbox Paper CMS\n\n[![NPM Total Downloads](https://img.shields.io/npm/dt/dropbox-paper-cms.svg)](https://www.npmjs.com/package/dropbox-paper-cms)\n[![David Dependencies Status](https://david-dm.org/HoukasaurusRex/dropbox-paper-cms.svg)](https://david-dm.org/HoukasaurusRex/dropbox-paper-cms)\n[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/HoukasaurusRex/dropbox-paper-cms.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/HoukasaurusRex/dropbox-paper-cms/context:javascript)\n[![prs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/HoukasaurusRex/dropbox-paper-cms/master)\n[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHoukasaurusRex%2Fdropbox-paper-cms.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FHoukasaurusRex%2Fdropbox-paper-cms?ref=badge_shield)\n\nUsing [Dropbox Paper APIs](https://dropbox.github.io/dropbox-api-v2-explorer/) to generate static content your CMS website\n\n*WARNING*: Sidebar auto-generation currently only compatible with vuepress\n\n![dropbox](assets/dropbox.png)\n![vuepress](assets/vuepress.png)\n\nDropbox Paper CMS was developed so that CMS sites could easily update their content without writing any code. One only needs to write documents in [Dropbox Paper](https://paper.dropbox.com/), and Dropbox Paper CMS  will fetch documents in markdown, save them locally, then optionally update your CMS sidebar with new file paths (currently only available for vuepress, [PRs welcome](https://github.com/HoukasaurusRex/dropbox-paper-cms/.github/CONTRIBUTING.md/.github/CONTRIBUTING.md)).\n\n## Contents  \n\n- [Getting Started](#getting-started)\n- [API Reference](#api-reference)\n  - [Docs Schema](#docs-schema)\n  - [fetchPaperDocs](#fetchpaperdocs)\n  - [generateContent](#generateContent)\n  - [generateConfig](#generateConfig) *experimental*\n- [Examples](#examples)\n- [Limitations](#limitations)\n- [Contributing](#contributing)\n- [Authors](#authors)\n- [License](#license)\n- [Acknowledgments](#acknowledgments)\n\n## Getting Started\n\n### Install\n\n- With NPM\n\n  ```sh\n  npm install dropbox-paper-cms\n  ```\n\n- With Yarn\n\n  ```sh\n  yarn add dropbox-paper-cms\n  ```\n\n### Generate Dropbox Paper API Token\n\n- Go to your [Dropbox App Console](https://www.dropbox.com/developers/apps)\n\n- Create a new App\n\n![Create App](assets/create-app.png)\n\n- Generate an access token\n\n![Generate Access Token](assets/generate-access-token.png)\n\n## API Reference\n\n### Docs Schema\n\nEach API makes use of this custom schema for your Dropbox Paper documents. Since the Dropbox Paper APIs do not provide a convenient way to fetch and manage content, this module attempts to alleviate that by providing a standard schema to use as you like with all your Dropbox Paper files.\n\n```js\n[\n  {\n    id: 'string',\n    folders: [\n      {\n        id: 'string',\n        name: 'string'\n      }\n    ],\n    metaData: JSON,\n    content: JSON,\n    location: 'string'\n  }\n]\n```\n\n### fetchPaperDocs\n\nFetches dropbox paper files and metaData from a list of dropbox folders and returns documents in a promise.\n\n#### Parameters\n\n`{Options}`\n\nPass an options object into the `fetchPaperDocs` function\n\n```js\n{\n  dropboxApiToken: 'string',\n  contentDir: 'string',\n  folders: [ 'string' ]\n}\n```\n\n| Option              | Type            | Description                                                                             | Example                                               |\n|-------------------  |---------------  |---------------------------------------------------------------------------------------  |------------------------------------------------------ |\n| dropboxApiToken     | String          | Token generated from your Dropbox Paper App Console                                     | bwgnBMfB-LFFFYDNIYVb1zC6J6kBkvp_FwvISvJp989Tm9dx      |\n| contentDir          | String          | Name or path of the directory you want dropbox-paper-cms to write markdown files to     | 'content'                                             |\n| folders            | [String]   | An array of folder names matching the folders in your Dropbox Paper directory              | ['blog', 'portfolio', 'guide']\n\n#### Returns\n\nPromise\u003c[Docs](#docs-schema)\u003e\n\n### generateContent\n\nWrites Dropbox Paper docs to local markdown files using node's filesystem module\n\n#### Parameters\n\n[Docs](#docs-schema), `contentDir`\n\nParameter        | Type                          | Description                                 | Example          |\n|--------------  |-----------------------------  |---------------------------------------------|----------------- |\n| Docs           | [Docs](#docs-schema)          | Docs returned from `fetchPaperDocs`         |                  |\n| contentDir     | String                        | Path to your static content directory       | './content'      |\n\n#### Returns\n\nPromise\u003c[Docs](#docs-schema)\u003e\n\n### generateConfig\n\nWrites Dropbox Paper docs to local markdown files using node's filesystem module\n\n#### Parameters\n\n[Docs](#docs-schema), `config`\n\nParameter        | Type                          | Description                                 | Example                          |\n|--------------  |-----------------------------  |---------------------------------------------|--------------------------------- |\n| Docs           | [Docs](#docs-schema)          | Docs returned from `fetchPaperDocs`         |                                  |\n| config         | JSON                          | Config file for your static site generator  | require('./.vuepress/config.js') |\n\n#### Returns\n\nPromise\u003c[Docs](#docs-schema)\u003e\n\n## Examples\n\n```js\nconst paperCMS = require('dropbox-paper-cms')\nconst vueConfig = require('./content/.vuepress/config')\n\nconst contentDir = 'content'\nconst options = {\n  contentDir,\n  dropboxApiToken: 'bwgnBMfB-LFFFYDNIYVb1zC6J6kBkvp_FwvISvJp989Tm9dx ', // NOTE: keep this token secret\n  folders: [\n    'blog',\n    'portfolio',\n    'guide'\n  ]\n}\n\npaperCMS\n  .fetchPaperDocs(options)\n  .then(docs =\u003e paperCMS.generateContent(docs, contentDir))\n  .then(docs =\u003e paperCMS.generateConfig(docs, vueConfig)) // only compatible with vuepress for now\n  .catch(console.error)\n```\n\n## Limitations\n\n- Dropbox API App tokens only support full access to dropbox paper account instead of limiting access to a single folder. This is why  you must specify the folders to match the corresponding folders in your Dropbox Paper account.\n\n- For now, sidebar content only generated in vuepress configuration files, so manual configuration is required for other static site generators.\n\n- Content is sorted alphabetically (or alphanumerically), but future versions will allow configuration.\n\n- Paper has no webhooks or other mechanism to trigger a new publication on document changes. (See acknowledgements below for a guide on publishing through slack)\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](https://github.com/HoukasaurusRex/dropbox-paper-cms/.github/CONTRIBUTING.md/.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## Authors\n\n- **JT Houk** - [HoukasaurusRex](https://github.com/HoukasaurusRex)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/HoukasaurusRex/dropbox-paper-cms/LICENSE) file for details\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHoukasaurusRex%2Fdropbox-paper-cms.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FHoukasaurusRex%2Fdropbox-paper-cms?ref=badge_large)\n\n## Acknowledgments\n\nThis project was inspired by a project by [De Voorhoede](https://github.com/voorhoede/playbook) on using Dropbox Paper as a Content Management System.\n\n[Guide to publish using slack webhooks](https://www.voorhoede.nl/en/blog/dropbox-paper-as-a-headless-cms/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoukasaurusrex%2Fdropbox-paper-cms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhoukasaurusrex%2Fdropbox-paper-cms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoukasaurusrex%2Fdropbox-paper-cms/lists"}