https://github.com/amberpixels/peppers
Markdown To Notion Factory
https://github.com/amberpixels/peppers
Last synced: about 1 year ago
JSON representation
Markdown To Notion Factory
- Host: GitHub
- URL: https://github.com/amberpixels/peppers
- Owner: amberpixels
- Created: 2024-11-11T20:06:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-03T20:23:44.000Z (over 1 year ago)
- Last Synced: 2025-03-13T03:20:00.886Z (over 1 year ago)
- Language: Go
- Size: 111 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# peppers 🌶️
**pprs** is a CLI tool designed to transform Markdown documentation into Notion pages.
If you're a developer managing multiple repositories, **pprs** aims to keep your README.md files as
the single source of truth while making them easily searchable and viewable in Notion.
This tool is ideal for automating the documentation process in CI setups, ensuring your project documentation stays up to date.
> **Note:** This project is in active development and is **NOT READY** for production use.
## How It Works
**peppers** uses the `jalapeno` library to convert Markdown AST (parsed with [Goldmark](https://github.com/yuin/goldmark))
into Notion blocks via the [Notion API](https://developers.notion.com/).
## Current Features
- **Markdown Syntax Supported:**
- Headings
- Emphasis (bold, italic, strikethrough)
- Lists (bulleted and numbered)
- Task lists
- Nested lists
- Code blocks
- Inline code
- Links and autolinks
- Blockquotes
- Horizontal rules (semantic breaks)
- Basic images (`![]()` syntax)
- Basic tables (not well tested with nested things inside)
- Limited HTML support (`
` only)
- **Notion Page Creation:**
- Converts a `.md` file to Notion blocks and uploads them to a Notion page using environment variables for configuration.
## Limitations (Work in Progress)
- **Markdown Syntax Not Yet Supported:**
- Advanced tables (tables + things inside)
- Footnotes
- Definition lists
- Escape characters
- **HTML Support:** Only `
` is supported. Other HTML elements are not parsed or converted.
## Roadmap
- [x] Add support for tables
- [ ] Add support for nested things inside tables
- [x] Add support for blockquotes
- [x] Add horizontal rules
- [ ] Handle footnotes and definition lists
- [x] Implement task lists and nested lists
- [ ] Improve HTML support
- [ ] Refactor and move `jalapeno` to `pkg` for independent use