Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brittonhayes/notionmd
🪄 Convert Markdown into Notion Blocks
https://github.com/brittonhayes/notionmd
golang markdown notion
Last synced: 3 months ago
JSON representation
🪄 Convert Markdown into Notion Blocks
- Host: GitHub
- URL: https://github.com/brittonhayes/notionmd
- Owner: brittonhayes
- License: mit
- Created: 2024-07-29T04:10:19.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-02T23:09:55.000Z (5 months ago)
- Last Synced: 2024-09-29T19:01:55.885Z (3 months ago)
- Topics: golang, markdown, notion
- Language: Go
- Homepage: https://brittonhayes.notion.site/Markdown-to-Notion-Blocks-910e034d5e534072bcddfbd06aafef0c
- Size: 65.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NotionMD
Seamlessly Convert Markdown to Notion Blocks
[](https://pkg.go.dev/github.com/brittonhayes/notionmd)
[](https://goreportcard.com/report/github.com/brittonhayes/notionmd)
NotionMD is a powerful Go package that bridges the gap between Markdown and Notion. It allows you to effortlessly convert your Markdown content into Notion blocks, making it easier than ever to integrate your existing Markdown documents into your Notion workspace.
## 🌟 Key Features
- **Markdown to Notion**: Convert Markdown documents to Notion blocks with a single function call
- **Rich Content Support**: Handles a variety of Markdown elements including headings, links, lists, and paragraphs
- **Large Document Handling**: Efficiently processes large documents by breaking blocks into manageable chunks
- **Easy Integration**: Designed to work seamlessly with Notion API clients
## 🚀 Quick Start
### Installation
Get started with NotionMD in your Go project:
```sh
go get github.com/brittonhayes/notionmd
```
### Basic Usage
Here's a simple example of how to use NotionMD:
```go
package main
import (
"encoding/json"
"log"
"fmt"
"github.com/brittonhayes/notionmd"
)
func main() {
markdown := `
# Welcome to NotionMD
- Convert Markdown easily
- Integrate with Notion seamlessly`
blocks, err := notionmd.Convert(markdown)
if err != nil {
log.Fatal(err)
}
// Print the resulting Notion blocks
result, _ := json.MarshalIndent(blocks, "", " ")
fmt.Println(string(result))
}
```
Click to see the output
```json
[
{
"heading_1": {
"rich_text": [
{
"type": "text",
"plain_text": "Welcome to NotionMD",
"text": {
"content": "Welcome to NotionMD"
}
}
],
"is_toggleable": false
}
},
{
"bulleted_list_item": {
"rich_text": [
{
"type": "text",
"plain_text": "Convert Markdown easily",
"text": {
"content": "Convert Markdown easily"
}
}
]
}
},
{
"bulleted_list_item": {
"rich_text": [
{
"type": "text",
"plain_text": "Integrate with Notion seamlessly",
"text": {
"content": "Integrate with Notion seamlessly"
}
}
]
}
}
]
```
### Creating a Notion Page from Markdown
This example demonstrates how to create a Notion page using the blocks parsed from a Markdown document
```go
package main
import (
"context"
"log"
"os"
"github.com/brittonhayes/notionmd"
"github.com/dstotijn/go-notion"
)
func main() {
// Read the Markdown file
markdown, err := os.ReadFile("example.md")
if err != nil {
log.Fatalf("Error reading Markdown file: %v", err)
}
// Convert the Markdown content to Notion blocks
blocks, err := notionmd.Convert(string(markdown))
if err != nil {
log.Fatalf("Error converting Markdown to Notion blocks: %v", err)
}
// Initialize the Notion client
client := notion.NewClient(os.Getenv("NOTION_API_KEY"))
// Create a new page in Notion
parentPageID := "your-parent-page-id" // Replace with your actual parent page ID
newPage, err := client.CreatePage(context.Background(), notion.CreatePageParams{
ParentType: notion.ParentTypePage,
ParentID: parentPageID,
Title: []notion.RichText{
{
Text: ¬ion.Text{
Content: "Markdown to Notion Example",
},
},
},
Children: blocks,
})
if err != nil {
log.Fatalf("Error creating Notion page: %v", err)
}
log.Printf("Successfully created Notion page with ID: %s", newPage.ID)
}
```
> [!NOTE]
> Make sure to set the `NOTION_API_KEY` environment variable with your Notion API key and replace `"your-parent-page-id"` with the actual ID of the parent page where you want to create the new page.
## 📝 Supported Markdown
- ✅ Headings
- ✅ Bold Text
- ✅ Italic Text
- ✅ Ordered Lists
- ✅ Unordered Lists
- ✅ Code Blocks
- ✅ Links
## 🧪 Testing
Ensure the reliability of NotionMD by running the test suite:
```sh
go test ./... -v -cover
```
## 🤝 Contributing
We welcome contributions from the community! If you'd like to contribute:
1. Fork the repository
2. Create a new branch for your feature or bug fix
3. Make your changes and write tests if applicable
4. Submit a pull request with a clear description of your changes
Please open an issue if you find a bug or have a feature request.
## 📄 License
NotionMD is open-source software licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgements
- [go-notion](https://github.com/dstotijn/go-notion) for Notion API interactions
- [gomarkdown](https://github.com/gomarkdown/gomarkdown) for Markdown parsing
## 📚 Learn More
For detailed API documentation and advanced usage examples, visit our [Go Package Documentation](https://pkg.go.dev/github.com/brittonhayes/notionmd).
---
Built with 🖤 by [Britton Hayes](https://github.com/brittonhayes) and contributors. If you find NotionMD useful, consider giving it a star on GitHub!