https://github.com/calumk/editorjs-codeflask

Code syntax highlighting tool for Editor.js, Built with Codeflask
https://github.com/calumk/editorjs-codeflask

Last synced: 3 months ago
JSON representation

Code syntax highlighting tool for Editor.js, Built with Codeflask

• Host: GitHub
• URL: https://github.com/calumk/editorjs-codeflask
• Owner: calumk
• Archived: true
• Created: 2022-04-19T12:18:34.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-13T08:19:31.000Z (10 months ago)
• Last Synced: 2024-07-10T13:15:40.773Z (4 months ago)
• Language: JavaScript
• Size: 750 KB
• Stars: 18
• Watchers: 2
• Forks: 23
• Open Issues: 9
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• awesome-editorjs - @calumk/editorjs-codeflask

README

        
# EditorJs - Codeflask

> [!WARNING]

> This repo is depreciated / archived.

> [!IMPORTANT]

> Due to changes in the core editor (Change from codeflask -> codecup) I have decided to fork this repo, and depreciate it.

>

> The Plugin originally relied on [CodeFlask](https://kazzkiq.github.io/CodeFlask/), which i have also forked, and republished as [CodeCup](https://github.com/calumk/codecup)

>

> As such, the plugin is now different enough, that i have decided to republish it under its new name, so I can accept issues/pull requests on the whole stack, and maintain it better going forwards

> 

> Please upgrade to [@calumk/editorjs-codecup](http://github.com/calumk/editorjs-codecup)

---

### NPM

    npm i @calumk/editorjs-codeflask

### JS

    https://cdn.jsdelivr.net/npm/@calumk/editorjs-codeflask@latest

---

## About

This is an EditorJs wrapper for [CodeFlask](https://kazzkiq.github.io/CodeFlask/) - A lovely lightweight zero-dep code formatter

It was built to be an improvement on :

* https://github.com/editor-js/code - Too Basic

* https://github.com/dev-juju/codebox - Agressive styling, and exports more data than markdown can handle

## Demo

![Demo ](./example-media/editorjs-codeflask-demo.gif)

## Built with:

* [CodeFlask](https://kazzkiq.github.io/CodeFlask/)

* [Prism](https://www.npmjs.com/package/prismjs)

* [Prism ESM Importer](https://www.npmjs.com/package/prismjs-components-importer)

* [Nice Select 2](https://www.npmjs.com/package/nice-select2)

---

## Installation / use

```javascript

import EditorJS from '@editorjs/editorjs';

import editorjsCodeflask from '@calumk/editorjs-codeflask';

var editor = EditorJS({

  // ...

  tools: {

    ...

    code : editorjsCodeflask

  },

});

```

## Data Format

The data imported/exported from the block is as follows:

| Name                       | Description                                                                                                              |

| -------------------------- | ------------------------------------------------------------------------------------------------------------------------ |

| code                       | The code that is displayed in the editor, with line breaks                                                               |

| language (optional)        | The programming language                                                                                                 |

| showlinenumbers (optional) | Will show/hide the line numbers (Default true) (WIP - [Codeflask #132](https://github.com/kazzkiq/CodeFlask/issues/132)) |

Since language and linenumbers are optional, existing ```code``` blocks can safley use this plugin