Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidscottmills/goeditorjs
An HTML/markdown generator for editorjs.
https://github.com/davidscottmills/goeditorjs
Last synced: 26 days ago
JSON representation
An HTML/markdown generator for editorjs.
- Host: GitHub
- URL: https://github.com/davidscottmills/goeditorjs
- Owner: davidscottmills
- License: mit
- Created: 2020-12-13T15:46:22.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-02T20:23:19.000Z (almost 3 years ago)
- Last Synced: 2024-08-03T17:09:31.176Z (4 months ago)
- Language: Go
- Homepage:
- Size: 27.3 KB
- Stars: 15
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-editorjs - davidscottmills/goeditorjs - An extensible HTML/markdown generator for editorjs. (Libraries / Go)
README
# davidscottmills/goeditorjs
An extensible library that converts [editor.js](https://editorjs.io/) data into HTML or markdown.
[](https://github.com/davidscottmills/goeditorjs/actions?query=workflow%3A%22test+and+build%22)
[](https://coveralls.io/github/davidscottmills/goeditorjs?branch=main)
[](https://goreportcard.com/report/github.com/davidscottmills/goeditorjs)
[](http://godoc.org/github.com/davidscottmills/goeditorjs)
[](https://github.com/davidscottmills/goeditorjs/issues)
[](https://github.com/davidscottmills/goeditorjs/LICENSE.md)
[](https://github.com/davidscottmills/goeditorjs)
## Installation
```bash
go get github.com/davidscottmills/goeditorjs
```
## Usage
```go
package main
import (
"io/ioutil"
"log"
"github.com/davidscottmills/goeditorjs"
)
func main() {
content, err := ioutil.ReadFile("editorjs_output.json")
if err != nil {
log.Fatal(err)
}
ejs := string(content)
// HTML
// Get the HTML engine
htmlEngine := goeditorjs.NewHTMLEngine()
// Register the handlers you wish to use
htmlEngine.RegisterBlockHandlers(
&goeditorjs.HeaderHandler{},
&goeditorjs.ParagraphHandler{},
&goeditorjs.ListHandler{},
&goeditorjs.CodeBoxHandler{},
)
// Generate the html
html, err := htmlEngine.GenerateHTML(ejs)
if err != nil {
log.Fatal(err)
}
// Do something with the html output. In this case, write it to a file.
err = ioutil.WriteFile("editorjs.html", []byte(html), 0644)
if err != nil {
log.Fatal(err)
}
// Generate markdown and save it to a file
// Get the markdown engine
markdownEngine := goeditorjs.NewMarkdownEngine()
// Register the handlers you wish to use
markdownEngine.RegisterBlockHandlers(
&goeditorjs.HeaderHandler{},
&goeditorjs.ParagraphHandler{},
&goeditorjs.ListHandler{},
&goeditorjs.CodeBoxHandler{},
)
// Generate the markdown
md, err := markdownEngine.GenerateMarkdown(ejs)
if err != nil {
log.Fatal(err)
}
// Do something with the md output. In this case, write it to a file.
err = ioutil.WriteFile("editorjs.md", []byte(md), 0644)
if err != nil {
log.Fatal(err)
}
}
```
## Using a Custom Handler
You can create and use your own handler in either engine by implementing the required interface and registering it.
This package provides two interfaces for handlers.
- `HTMLBlockHandler`
```go
type HTMLBlockHandler interface {
Type() string // Type returns the type the block handler supports as a string
GenerateHTML(editorJSBlock EditorJSBlock) (string, error) // Return associated HTML
}
```
- `MarkdownBlockHandler`
```go
type MarkdownBlockHandler interface {
Type() string // Type returns the type the block handler supports as a string
GenerateMarkdown(editorJSBlock EditorJSBlock) (string, error) // Return associated markdown
}
```
If you're only planning to use the HTMLEngine, then you only need to implement the `HTMLBlockHandler` interface. The same goes for markdown.
Once you've met the required interface, register the handler for use in the engine.
```go
htmlEngine := goeditorjs.NewHTMLEngine()
// Register the handlers you wish to use
htmlEngine.RegisterBlockHandlers(
&MyCustomBlockHandler{},
)
```
Below is an example of how the header handle is implemented.
```go
package header
import (
"encoding/json"
"fmt"
)
// HeaderHandler is the default HeaderHandler for EditorJS HTML generation
type HeaderHandler struct {
// Notice that you could put some configurable options in this struct and then use them in your handler
}
// Header represents header data from EditorJS
type Header struct {
Text string `json:"text"`
Level int `json:"level"`
}
func (*HeaderHandler) parse(editorJSBlock EditorJSBlock) (*Header, error) {
header := &Header{}
return header, json.Unmarshal(editorJSBlock.Data, header)
}
// Type "header"
func (*HeaderHandler) Type() string {
return "header"
}
// GenerateHTML generates html for HeaderBlocks
func (h *HeaderHandler) GenerateHTML(editorJSBlock EditorJSBlock) (string, error) {
header, err := h.parse(editorJSBlock)
if err != nil {
return "", err
}
return fmt.Sprintf("%s", header.Level, header.Text, header.Level), nil
}
// GenerateMarkdown generates markdown for HeaderBlocks
func (h *HeaderHandler) GenerateMarkdown(editorJSBlock EditorJSBlock) (string, error) {
header, err := h.parse(editorJSBlock)
if err != nil {
return "", err
}
return fmt.Sprintf("%s %s", strings.Repeat("#", header.Level), header.Text), nil
}
```
## TODO
- Provide more handlers (table, etc.)