Notion2Md 完整安装指南:从零开始配置 Python 环境与 Notion API 密钥

【免费下载链接】notion2md Notion Markdown Exporter with Python Cli 【免费下载链接】notion2md 项目地址: https://gitcode.com/gh_mirrors/no/notion2md

想要将 Notion 页面快速转换为 Markdown 格式吗?Notion2Md 是您的终极解决方案!这个强大的 Python CLI 工具能够将 Notion 内容无缝导出为 Markdown 文件,支持图片下载和完整格式转换。本指南将带您完成从零开始的完整安装配置过程,让您轻松掌握 Notion 内容导出技巧。✨

📋 准备工作:Python 环境与 Notion API 密钥

在开始使用 Notion2Md 之前,您需要准备好两个关键要素:Python 运行环境和 Notion API 密钥。

Python 环境检查与安装

首先确认您的系统是否已安装 Python 3.7 或更高版本:

python --version

如果未安装 Python,请访问 Python 官网 下载最新版本。推荐使用 Python 3.9 或更高版本以获得最佳兼容性。

获取 Notion API 密钥

Notion2Md 使用官方 Notion API 进行数据访问,因此您需要创建 Notion 集成并获取 API 密钥:

  1. 访问 Notion 集成页面
  2. 点击 "New integration" 创建新集成
  3. 为集成命名(如 "Notion2Md Exporter")
  4. 选择关联的工作区
  5. 点击 "Submit" 创建集成
  6. 在集成详情页找到 "Internal Integration Token" 并复制

Notion2Md 工具界面展示

🚀 快速安装 Notion2Md 工具

Notion2Md 可以通过 pip 一键安装,这是最简单快捷的方式:

pip install notion2md

安装完成后,验证安装是否成功:

notion2md --version

如果看到版本号输出(如 2.9.0),说明安装成功!🎉

高级安装选项

对于开发人员或需要自定义安装的用户,可以选择从源码安装:

git clone https://gitcode.com/gh_mirrors/no/notion2md
cd notion2md
pip install -e .

这种方式允许您直接修改源码并立即生效,适合二次开发或调试。

🔑 配置 Notion API 密钥的三种方法

Notion2Md 支持多种方式配置 API 密钥,您可以根据使用场景选择最合适的方法。

方法一:环境变量配置(推荐)

将 Notion API 密钥设置为环境变量,这是最安全且持久的方式:

export NOTION_TOKEN="your_integration_token_here"

为了使环境变量永久生效,可以将上述命令添加到您的 shell 配置文件(如 ~/.bashrc~/.zshrc~/.profile)中。

方法二:命令行参数传递

从 Notion2Md 2.9.0 版本开始,您可以直接在命令行中传递 API 密钥:

notion2md --token "your_token_here" -u "https://notion.so/your-page"

这种方式适合临时使用或脚本自动化场景。

方法三:Python 代码中配置

如果您在 Python 脚本中使用 Notion2Md,可以直接在代码中设置:

import os
os.environ["NOTION_TOKEN"] = "your_token_here"

📝 分享 Notion 页面权限给集成

获取 API 密钥后,还需要将 Notion 页面分享给您的集成:

  1. 打开要导出的 Notion 页面
  2. 点击右上角的 "..." 菜单
  3. 选择 "Add connections"
  4. 搜索并选择您创建的集成名称
  5. 确认权限分享

Notion2Md 命令行选项展示

🔧 Notion2Md 基本使用方法

掌握基本命令格式,开始您的 Notion 内容导出之旅!

通过页面 URL 导出

最简单的使用方式是通过 Notion 页面链接:

notion2md -u "https://notion.so/your-page-url"

通过页面 ID 导出

如果您知道页面的 ID,也可以直接使用:

notion2md -i "page_id_here"

下载图片和文件

使用 --download 选项自动下载页面中的所有图片和附件:

notion2md --download -u "https://notion.so/your-page"

指定输出路径和文件名

自定义输出位置和文件名:

notion2md --download -n "my_article" -p "~/Documents/notion_exports" -u "https://notion.so/your-page"

这个命令将在指定目录生成 my_article.zip 文件。

🎯 高级功能与配置选项

Notion2Md 提供了丰富的配置选项,满足不同使用场景的需求。

导出未压缩的 Markdown

使用 --unzipped 选项直接导出未压缩的 Markdown 文件:

notion2md --unzipped -u "https://notion.so/your-page"

批量导出多个页面

通过编写简单的脚本实现批量导出:

#!/usr/bin/env python3
import subprocess

pages = [
    "https://notion.so/page1",
    "https://notion.so/page2",
    "https://notion.so/page3"
]

for page_url in pages:
    subprocess.run(["notion2md", "--download", "-u", page_url])

在 Python 代码中使用

Notion2Md 也提供了 Python API,方便集成到您的项目中:

from notion2md.exporter.block import MarkdownExporter, StringExporter

# 导出为文件
MarkdownExporter(
    block_id='your_page_id',
    output_path='./output',
    download=True
).export()

# 导出为字符串
md_content = StringExporter(
    block_id='your_page_id',
    output_path='./output'
).export()

🛠️ 故障排除与常见问题

权限错误处理

如果遇到权限错误,请检查:

  1. API 密钥是否正确
  2. 页面是否已分享给集成
  3. 集成是否在正确的 Notion 工作区中

安装问题解决

如果 pip 安装失败,可以尝试:

pip install --upgrade pip
pip install notion2md --no-cache-dir

版本兼容性

确保您的 Python 版本符合要求(≥3.7),并检查依赖包版本:

pip list | grep notion-client

📊 项目结构与核心模块

了解 Notion2Md 的项目结构有助于深入使用和定制:

🚀 下一步:开始您的 Notion 内容导出之旅

现在您已经完成了 Notion2Md 的完整安装和配置!🎊 接下来可以:

  1. 尝试导出您的第一个 Notion 页面
  2. 探索不同的导出选项和参数
  3. 将导出的 Markdown 用于博客、文档或知识库
  4. 自动化您的文档工作流程

记住,Notion2Md 支持持续更新和改进,定期检查新版本可以获取更多功能和性能优化。如果您在使用过程中遇到任何问题,可以参考项目文档或社区支持。

开始享受 Notion 内容导出的便利吧!您的 Markdown 转换之旅从此开始!🚀

【免费下载链接】notion2md Notion Markdown Exporter with Python Cli 【免费下载链接】notion2md 项目地址: https://gitcode.com/gh_mirrors/no/notion2md

更多推荐