# @blog-o-matic/editor

> Editor for Blog-o-Matic blogs

Latest version **4.5.1** (published 2019-10-08) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @blog-o-matic/editor
pnpm add @blog-o-matic/editor
yarn add @blog-o-matic/editor
bun add @blog-o-matic/editor
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 4.5.1 |
| Published | 2019-10-08 |
| First published | 2018-12-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 15.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ben Pevsner |
| Maintainers | ivebencrazy |

## Links

- npm: https://www.npmjs.com/package/@blog-o-matic/editor
- Repository: https://github.com/ivebencrazy/blog-o-matic
- Homepage: https://github.com/ivebencrazy/blog-o-matic#readme
- Issues: https://github.com/ivebencrazy/blog-o-matic/issues
- npm.io page: https://npm.io/package/@blog-o-matic/editor

## Dependencies (6)

- [open](https://npm.io/package/open.md) ^6.4.0
- [marksy](https://npm.io/package/marksy.md) ^8.0.0
- [express](https://npm.io/package/express.md) ^4.17.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1
- [@civility/utilities](https://npm.io/package/@civility/utilities.md) ^0.2.1
- [@blog-o-matic/editor-client](https://npm.io/package/@blog-o-matic/editor-client.md) ^4.5.1

## Recent versions

- 4.5.1 (latest) — 2019-10-08
- 4.5.0 — 2019-10-08
- 4.4.3 — 2019-09-19
- 4.4.2 — 2019-09-19
- 4.4.1 — 2019-09-16
- 4.3.7 — 2019-02-06
- 4.3.5 — 2019-02-03
- 4.3.4 — 2019-02-01
- 4.3.1 — 2019-01-28
- 4.3.0 — 2019-01-21
- 4.2.3 — 2019-01-10
- 4.1.0 — 2018-12-25
- 4.0.6 — 2018-12-23
- 4.0.5 — 2018-12-16
- 4.0.4 — 2018-12-16
- … 1 more at https://npm.io/package/@blog-o-matic/editor/versions

## README

Blog-o-Matic Editor
===
Server and GUI for the Editor used in cli's `edit` command. When initialized locally, we can essentially create a lighter-weight, cross-browser [Electron](https://electronjs.org/)-esqe experience that runs in a browser. This client can also be exported separately for use in a website, but it will only make api calls. I don't expect anyone to actually use this to actually edit their blog online. If after building this, it doesn't seem like a useful export, I will probably bundle it into `@blog-o-matic/cli`. It might become useful if we actually make a real [Electron](https://electronjs.org/) executable. However I don't see this happening in the near future at all.

The editor is built with create-react-app, and served with an express server.

Usage
---
```html
<!-- Client might just export a whole site script, tbh -->
<script src="node_modules/@blog-o-matic/editor/client"></script>
```

Markdown Spec
===
All Blog-o-Matic markdown is valid [Github Markdown](https://github.github.com/gfm/).

Blog-o-Matic also introduces custom entity groups, which will be described in this document. These entities are additive to Github Markdown (for example, a list of images will turn into an image group).

Blog-o-Matic Entities
---
- Image Group: Responsive groups of images
- Playlist: Read a playlist file as a playlist.
- Music: Read a music link as a playable sound

Styled Entities
---
Read url params from content, adjusting behavior as necessary.
- Styled Image: Progressive loading, image size control, parallaxing/animation
- Styled Playlist: Show a playable playlist, be able to play simultaneous, etc.

---
_Source: https://npm.io/package/@blog-o-matic/editor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._