Notion2md 项目教程

1. 项目的目录结构及介绍

Notion2md 项目的目录结构如下：

notion2md/
├── tests/
│   └── ...
├── flake8/
│   └── ...
├── .gitignore
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── CONTRIBUTION.md
├── LICENSE
├── Notion2md.jpg
├── README.md
├── notion2md_options.png
├── pyproject.toml
└── exporter.py

目录结构介绍

• tests/: 包含项目的测试文件。
• flake8/: 包含代码风格检查的相关配置文件。
• .gitignore: Git 忽略文件配置。
• .pre-commit-config.yaml: 预提交钩子配置文件。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTION.md: 贡献指南。
• LICENSE: 项目许可证文件。
• Notion2md.jpg: 项目图标。
• README.md: 项目介绍和使用说明。
• notion2md_options.png: 项目选项截图。
• pyproject.toml: Python 项目配置文件。
• exporter.py: 项目的主要功能实现文件。

2. 项目的启动文件介绍

Notion2md 项目的启动文件是 exporter.py。该文件包含了主要的导出功能实现。

exporter.py 文件介绍

• MarkdownExporter 类: 用于将 Notion 页面导出为 Markdown 文件。
• StringExporter 类: 用于将 Notion 页面导出为字符串格式。

示例代码：

from notion2md.exporter.block import MarkdownExporter, StringExporter

# 使用 MarkdownExporter 导出为 Markdown 文件
markdown_exporter = MarkdownExporter(block_id='your_block_id', output_path='output_path', download=True)
markdown_exporter.export()

# 使用 StringExporter 导出为字符串
string_exporter = StringExporter(block_id='your_block_id', output_path='output_path')
md_string = string_exporter.export()

3. 项目的配置文件介绍

Notion2md 项目的主要配置文件是 pyproject.toml。该文件用于配置项目的依赖和构建工具。

pyproject.toml 文件介绍

• [tool.poetry]: 配置项目的依赖和元数据。
• [build-system]: 配置构建系统的要求。

示例配置：

[tool.poetry]
name = "notion2md"
version = "2.9.0"
description = "Notion Markdown Exporter"
authors = ["Eunchan Cho <[e-mail]>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.7"
notion-sdk-py = "^0.1.0"

[tool.poetry.dev-dependencies]
pytest = "^6.2.5"
flake8 = "^4.0.1"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

通过以上配置，可以管理项目的依赖和构建过程。