doc2markdown

Project renamed to: https://github.com/AntiMoron/doc2markdown This one archived.

Convert Feishu (飞书) and Google Docs documents to Markdown — automatically.

Feishu to Markdown · Google Docs to Markdown · 飞书转Markdown · 飞书文档转MD

Keywords: feishu to markdown, feishu doc to markdown, 飞书转markdown, 飞书文档转markdown, google docs to markdown, google doc to markdown, doc2markdown, docx to markdown, nodejs, typescript

---

Why doc2markdown?

Most knowledge lives in Feishu docs or Google Docs. Getting that content into Markdown — for static sites, RAG pipelines, LLM context, or version-controlled wikis — is painful to do by hand. doc2markdown automates the whole thing: authenticate once, point at a doc or folder, get clean Markdown out.

Features

• Feishu (飞书) → Markdown — batch-convert an entire Feishu folder or a single doc via appId / appSecret
• Google Docs → Markdown — convert Google Docs via OAuth2 credentials
• Image download with configurable storage target (imageStorageTarget)
• Skip images entirely with skipImages: true for faster text-only runs
• Post-process every image URL with a handleImage callback (e.g. re-upload to your CDN)
• Progress callbacks and per-doc finish hooks
• AI/RAG-friendly: use a Feishu or Google Drive folder as a knowledge base

Supported Platforms

Platform	Status
Feishu (飞书)	✅
Google Docs	✅
Dingtalk Doc	planned

---

Installation

npm install doc2markdown
# or
yarn add doc2markdown

---

Usage

Feishu (飞书) → Markdown

1. Create a Feishu internal app at https://open.feishu.cn/
2. Grant the app these permissions:
   • docx:document:readonly
   • drive:drive
   • space:document:retrieve

import handleDoc from "doc2markdown";
import * as fs from "fs";
import * as path from "path";

handleDoc({
  type: "feishu",
  appId: "YOUR_APP_ID",
  appSecret: "YOUR_APP_SECRET",

  // Single doc by URL:
  docUrl: "https://yourcompany.feishu.cn/docx/XXXXXX",
  // Or an entire folder:
  // folderToken: "YOUR_FOLDER_TOKEN",

  handleProgress: (done, errors, total) => {
    console.log(`${done}/${total} done, ${errors} errors`);
  },
  onDocFinish: (docId, markdown) => {
    fs.writeFileSync(path.resolve(process.cwd(), `${docId}.md`), markdown);
  },
});

Google Docs → Markdown

1. Create an OAuth2 client in Google Cloud Console
2. Enable the Google Docs API and Google Drive API
3. Obtain a refresh token (e.g. via the OAuth2 Playground)

import handleDoc from "doc2markdown";
import * as fs from "fs";
import * as path from "path";

handleDoc({
  type: "googledoc",
  appId: "YOUR_OAUTH_CLIENT_ID",
  appSecret: "YOUR_OAUTH_CLIENT_SECRET",
  refreshToken: "YOUR_REFRESH_TOKEN",

  // Single doc by URL:
  docUrl: "https://docs.google.com/document/d/XXXXXX/edit",
  // Or an entire Drive folder:
  // folderToken: "YOUR_DRIVE_FOLDER_ID",

  handleProgress: (done, errors, total) => {
    console.log(`${done}/${total} done, ${errors} errors`);
  },
  onDocFinish: (docId, markdown) => {
    fs.writeFileSync(path.resolve(process.cwd(), `${docId}.md`), markdown);
  },
});

Get the document task list

import { getDocTaskList } from "doc2markdown";

getDocTaskList({
  type: "feishu", // or "googledoc"
  appId: "...",
  appSecret: "...",
  docUrl: "https://yourcompany.feishu.cn/docx/XXXXXX",
}).then(tasks => console.log(tasks));

---

Options

Option	Type	Description
type	"feishu" | "googledoc"	Document platform
appId	string	Feishu App ID or Google OAuth client ID
appSecret	string	Feishu App Secret or Google OAuth client secret
refreshToken	string	Google OAuth refresh token (Google Docs only)
docUrl	string	URL of a single document
docToken	string	Document token / ID (alternative to docUrl)
folderToken	string	Folder token / Drive folder ID for batch processing
skipImages	boolean	Skip all images (faster text-only conversion)
imageStorageTarget	string | (url, docId, meta) => string	Directory path or function returning the full file path for downloaded images
handleImage	(localPath) => string | Promise<string>	Transform the local image path before embedding in Markdown (e.g. upload to CDN)
handleProgress	(done, errors, total) => void	Progress callback
onDocFinish	(docId, markdown, metadata?) => void	Called when each document finishes
shouldHandleUrl	(url) => Promise<boolean>	Filter which documents to process

---

Roadmap

PRs welcome — if you find this useful, come contribute instead of just starring it.

Platform	Status
Feishu (飞书)	✅ done
Google Docs	✅ done
Dingtalk Doc	planned