Supported Formats

This article is used to demonstrate the formats that feishu-docx can perfectly support after exporting, and the ones listed below can all have good support.

Due to the limited data provided by Feishu OpenAPI , feishu-docx export cannot restore 100% of the format in Feishu Docs, and can actually achieve 99% of the effect.

Known unsupported formats:

• Base - Feishu Base (spreadsheet) is independent data, and the data format is large and complex, which is not supported for the time being. Please use ordinary tables when writing documents.

• Flowchart / UML diagram / Drawing board / Mindmap - the above are the sub-application functions of Feishu Docs, and the Feishu Docs currently docked does not provide such data or pictures, so it cannot be realized.

  • How to export FlowChat

• Image size, cropping - the image will be output in the original way, because the Feishu OpenAPI does not give the image cropping and scaling size information, so the exported content does not contain width, height, this can be based on the final page setting image 100% width to achieve.

• Formula - not supported yet, this may be supported later.

• Other Feishu third-party components - this cannot be supported, API does not provide data.

• Text color - The foreground color and background color of the text are not supported for the time being due to Markdown output.

Based on the above, it is recommended to use supported formats as much as possible when writing documents on the Feishu side. The formats that are currently supported can meet the document formatting needs of document writing (such as help documents, blogs) and other scenarios.

---

Here is the full format demonstration

This is heading 2

This is heading 3

This is heading 4

This is heading 5

This is heading 6

This is a block quote. With a new line.

Paragraph

Export Feishu Knowledge Base and generate Static Page Generator with the same directory structure supports Markdown file organization for publishing as a static website .

Generate Feishu Wiki into a Markdown for work with Static Page Generators.

Callout

❤️

Red Callout

💡

Orange Callout

🤖

Yellow Callout

✅

Green Callout

🐳

Blue Callout

🐳

Purple Callout

🐼

Gray Callout

Grid

Here is a 3 column grid example:

Bullet List

• Projects

  • GitHub
  • Twitter
    • x.com
  • Facebook

• OpenSource

  • feishu-pages
  • feishu-docx

Ordered List

1. This is 1 item

   1. This is a item
      1. This is i
   2. This is b
   3. This c

2. This is 2 item

   1. This is 2.1
   2. This is 2.2

CodeBlock

A JSON example:

{
  "name": "feishu-pages",
}

A TypeScript example:

const name = "feishu-pages";

TODO

• [x] This item is completed

• [ ] This is imcomplete

Divider

There is a divider

---

To split contents.

Image

An example of an image with caption.

File

test-file.zip

Table

Currently, feishu-docx only supports pure Table.

Name	Type	Website
GitHub	Programming	https://github.com
Twitter	Social Network	https://x.com
Dribbble	Design	https://dribbble.com

Equation

$$E=m{c}^2$$

Iframe