Martian: Markdown 到 Notion 转换器使用手册

Martian: Markdown 到 Notion 转换器使用手册

martian Markdown to Notion: Convert Markdown and GitHub Flavoured Markdown to Notion API Blocks and RichText 🔀📝 项目地址: https://gitcode.com/gh_mirrors/ma/martian

1. 目录结构及介绍

Martian 是一个强大的工具，用于将 Markdown 格式的内容转换成 Notion API 可接受的块（blocks）和富文本对象。以下为其基本的项目目录结构概述：

martian
├── eslintignore                 # ESLint 忽略文件
├── eslintrc.yml                # ESLint 配置文件
├── gitignore                   # Git 忽略文件
├── prettierrc.js               # Prettier 格式化配置
├── CODE_OF_CONDUCT.md          # 社区行为准则
├── LICENSE                     # 开源许可协议
├── README.md                   # 项目说明文档
├── jest.config.ts              # Jest 测试框架配置
├── package-lock.json           # NPM 包依赖锁定文件
├── package.json                # 项目元数据和依赖列表
├── tsconfig.json               # TypeScript 编译配置
├── scripts                     # 存放构建或脚本相关文件的目录
└── src                         # 源代码目录，包含主要逻辑实现
    └── ...                      # 源码文件，具体包括转换Markdown的核心逻辑等

重要文件解释：

• src: 实现Markdown到Notion转换的主要逻辑。
• package.json: 包含了项目的元数据，如版本号、作者信息、入口文件、依赖项以及执行脚本命令。
• tsconfig.json: TypeScript编译设置，确保正确编译TypeScript源代码。
• README.md: 提供了项目简介和如何使用的快速指南。

2. 项目的启动文件介绍

在 Martian 项目中，并没有传统意义上的“启动文件”作为直接应用程序运行。它设计为库（library），通过NPM包导入并在其他项目中使用。开发者在自己的项目中通过导入其提供的函数来使用它的功能，例如：

// 使用Node.js导入方式
const [markdownToBlocks, markdownToRichText] = require('@tryfabric/martian');

// 或者，在支持TypeScript的环境下
import [markdownToBlocks, markdownToRichText] from '@tryfabric/martian';

3. 项目的配置文件介绍

Martian本身不直接提供一个用户级的配置文件，其功能和行为调整主要是通过函数调用时传入的选项参数进行控制。比如处理超出了Notion限制的输出、图片URL验证严格性等，这些都是通过API调用时的选项对象来定制的：

const options = {
  notionLimits: { truncate: false }, // 是否禁用自动截断以适应Notion的限制
  strictImageUrls: false, // 是否允许将无效图片URL转化为文本而非抛出错误
};
markdownToBlocks('你的Markdown文本', options);

这些配置项使用户能够在调用转换函数时灵活地管理Markdown到Notion转换过程中的特定需求，无需直接编辑项目内部的配置文件。

martian Markdown to Notion: Convert Markdown and GitHub Flavoured Markdown to Notion API Blocks and RichText 🔀📝 项目地址: https://gitcode.com/gh_mirrors/ma/martian