git-notion 项目教程
1. 项目的目录结构及介绍
git-notion 项目的目录结构如下:
git-notion/
├── docs/
├── tests/
├── .gitignore
├── LICENSE
├── README.md
├── requirements.in
├── setup.cfg
├── setup.py
- docs/: 包含项目的文档文件。
- tests/: 包含项目的测试文件。
- .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
- LICENSE: 项目的许可证文件,采用 MIT 许可证。
- README.md: 项目的介绍和使用说明。
- requirements.in: 项目依赖的输入文件。
- setup.cfg: 项目的配置文件。
- setup.py: 项目的安装脚本。
2. 项目的启动文件介绍
项目的启动文件是 setup.py
,它负责项目的安装和配置。通过运行以下命令可以安装项目:
python3 setup.py install
3. 项目的配置文件介绍
项目的配置文件是 setup.cfg
,它包含项目的各种配置参数。以下是一些关键配置项的介绍:
[git-notion]
ignore_regex = models/*
notion_root_page = https://www.notion.so/
- ignore_regex: 指定要忽略的文件路径的正则表达式。
- notion_root_page: 指定 Notion 页面的根 URL。
此外,还可以在 setup.cfg
中配置特定 GitHub 文件夹到 Notion 子页面的映射:
[folders]
docs = <any_notion_url>
docs/NestedTest = <any_other_notion_url>
这些配置项可以帮助你更灵活地管理 GitHub 和 Notion 之间的同步。