Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anandchowdhary/docs-markdown
📝 Convert a Google Docs file (API response) to Markdown
https://github.com/anandchowdhary/docs-markdown
google google-docs google-drive markdown nodejs typescript
Last synced: 12 days ago
JSON representation
📝 Convert a Google Docs file (API response) to Markdown
- Host: GitHub
- URL: https://github.com/anandchowdhary/docs-markdown
- Owner: AnandChowdhary
- License: mit
- Created: 2020-04-16T19:08:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T21:51:56.000Z (6 months ago)
- Last Synced: 2025-01-05T07:09:43.473Z (19 days ago)
- Topics: google, google-docs, google-drive, markdown, nodejs, typescript
- Language: TypeScript
- Homepage: https://anandchowdhary.github.io/docs-markdown/
- Size: 547 KB
- Stars: 58
- Watchers: 4
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📝 Docs Markdown
Convert a Google Docs file (API response) to Markdown
[](https://github.com/AnandChowdhary/docs-markdown/actions)
[](https://travis-ci.org/AnandChowdhary/docs-markdown)
[](https://coveralls.io/github/AnandChowdhary/docs-markdown?branch=master)
[](https://libraries.io/npm/docs-markdown)
[](https://github.com/AnandChowdhary/docs-markdown/blob/master/LICENSE)
[](https://snyk.io/test/npm/docs-markdown)
[](https://github.com/AnandChowdhary/node.ts)
[](https://unpkg.com/browse/docs-markdown/dist/index.d.ts)
[](https://www.npmjs.com/package/node.ts)
[](https://www.npmjs.com/package/node.ts)
[](https://github.com/AnandChowdhary/docs-markdown/graphs/contributors)
[](https://github.com/semantic-release/semantic-release)
[](https://www.npmjs.com/package/docs-markdown)
## 💡 Usage
Install the package from [npm](https://www.npmjs.com/package/docs-markdown):
```bash
npm install docs-markdown
```
### API
The `fetchGoogleDocsFiles` helper can download a document from Google Docs and save it as a markdown file:
```ts
import { fetchGoogleDocsFiles } from "docs-markdown";
// Google Docs document ID
await fetchGoogleDocsFiles(["1UEUrJ98RXu9BNcFj3pMgiUALQpjIb8Y-gNu-YhlYvFQ"]);
// Google Docs document ID and file name
await fetchGoogleDocsFiles(["1UEUrJ98RXu9BNcFj3pMgiUALQpjIb8Y-gNu-YhlYvFQ:filename.md"]);
// Multiple Google Docs documents (comma-separated string)
await fetchGoogleDocsFiles(["documentId1", "documentId2", "documentId3"]);
```
You can also use the `googleDocsToMarkdown` function to manually convert documents:
```ts
import { googleDocsToMarkdown } from "docs-markdown";
import { google } from "googleapis";
import { writeFileSync } from "fs";
const oauth2Client = new google.auth.OAuth2(); // Authenticate
const docs = google.docs("v1");
const file = await docs.documents.get({
documentId: "Google Docs document ID",
auth: oauth2Client,
});
const markdown = googleDocsToMarkdown(file.data);
writeFileSync("file.md", markdown);
```
### CLI
Fetch files and save them as markdown:
```bash
# Google Docs document ID
docs-markdown fetch "1UEUrJ98RXu9BNcFj3pMgiUALQpjIb8Y-gNu-YhlYvFQ"
# Google Docs document ID with file name
docs-markdown fetch "1UEUrJ98RXu9BNcFj3pMgiUALQpjIb8Y-gNu-YhlYvFQ:filename.md"
# Multiple Google Docs documents
docs-markdown fetch "documentId1, documentId2, documentId3"
# Convert a JSON document to markdown
docs-markdown convert "path/to/file.json"
```
### Authentication
The following environment variables are required to fetch files from Google Docs. They are not required when converting JSON documents to markdown:
- `GOOGLE_DOCS_CLIENT_ID`
- `GOOGLE_DOCS_CLIENT_SECRET`
- `GOOGLE_DOCS_ACCESS`
- `GOOGLE_DOCS_REFRESH`
To learn how to create a client ID and secret, read the article [Using OAuth 2.0 to Access Google APIs](https://developers.google.com/identity/protocols/oauth2). Once you've created them, create an access token and a refresh token, use the [OAuth 2.0 Playground](https://developers.google.com/oauthplayground/) with your client ID and secret.
## ⭐️ Features
- [x] Paragraphs
- [x] Headings, titles, subtitles
- [x] Bold, italic
- [x] Lists
- [x] Links
- [ ] Images
- [x] Tables
- [ ] Header, footer
## 🍳 Recipes
### GitHub Actions + Google Docs CI
If you want to sync your Google Docs documents as markdown files to a GitHub repository, you can use this GitHub Actions workflow that runs every day, fetches your documents, and commit them to your repo. Make sure you have all the required environment variables stored as GitHub Secrets:
```yml
name: Google Docs
on:
schedule:
- cron: "0 0 * * *"
jobs:
release:
name: Fetch Google Docs
runs-on: ubuntu-18.04
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Node.js
uses: actions/setup-node@v1
with:
node-version: 12
- name: Download files
run: npx docs-markdown fetch "1UEUrJ98RXu9BNcFj3pMgiUALQpjIb8Y-gNu-YhlYvFQ"
env:
GOOGLE_DOCS_ACCESS: ${{ secrets.GOOGLE_DOCS_ACCESS }}
GOOGLE_DOCS_REFRESH: ${{ secrets.GOOGLE_DOCS_REFRESH }}
GOOGLE_DOCS_CLIENT_ID: ${{ secrets.GOOGLE_DOCS_CLIENT_ID }}
GOOGLE_DOCS_CLIENT_SECRET: ${{ secrets.GOOGLE_DOCS_CLIENT_SECRET }}
- name: Commit new data
uses: stefanzweifel/[email protected]
with:
commit_message: "Update Google Docs file"
commit_user_name: GitHub Actions
commit_user_email: [email protected]
commit_author: GitHub Actions
```
## 👩💻 Development
Build TypeScript:
```bash
npm run build
```
## 📄 License
[MIT](./LICENSE) © [Anand Chowdhary](https://anandchowdhary.com)