Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanford/remark-slate
Remark plugin to compile Markdown as a slate 0.50+ compatible object.
https://github.com/hanford/remark-slate
markdown remark remark-plugins rte slatejs
Last synced: 16 days ago
JSON representation
Remark plugin to compile Markdown as a slate 0.50+ compatible object.
- Host: GitHub
- URL: https://github.com/hanford/remark-slate
- Owner: hanford
- Created: 2020-03-30T02:19:47.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-14T09:16:56.000Z (5 months ago)
- Last Synced: 2024-10-07T17:37:42.786Z (about 1 month ago)
- Topics: markdown, remark, remark-plugins, rte, slatejs
- Language: TypeScript
- Homepage:
- Size: 984 KB
- Stars: 154
- Watchers: 4
- Forks: 41
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# remark-slate
> Transform the contents of a slate 0.50+ editor into markdown and back again.
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[**remark**][remark] plugin to compile Markdown as a [Slate](https://www.slatejs.org/) 0.50+ compatible object.
- [Slate ➡️ Markdown:](#slate-object-to-markdown)
- [Markdown ➡️ Slate:](#markdown-to-slate-object)
- [Miscellaneous](#miscellaneous)
- [Local Development](#local-development)
- [`npm start` or `yarn start`](#npm-start-or-yarn-start)
- [`npm run build` or `yarn build`](#npm-run-build-or-yarn-build)
- [`npm test` or `yarn test`](#npm-test-or-yarn-test)
- [License (MIT)](#license-mit)
## Usage
### Slate object to Markdown:
`remark-slate` exports an opinionated `serialize` function that is meant to be invoked with a `slate 0.50+` state object and will transform the object into a markdown document.
```js
import { serialize } from 'remark-slate';
export default ({ onChange }) => {
const [value, setValue] = useState(initialValue);
const handleChange = useCallback((nextValue) => {
setValue(nextValue);
// serialize slate state to a markdown string
onChange(value.map((v) => serialize(v)).join(''));
}, [onChange]);
return (
...
);
};
```
### Markdown to Slate object:
When deserializing from markdown to slate, this package is meant to be used with [remark-parse](https://github.com/remarkjs/remark/tree/master/packages/remark-parse) and [unified](https://github.com/unifiedjs/unified).
Our JS looks something like this:
```js
import fs from 'fs';
import unified from 'unified';
import markdown from 'remark-parse';
import slate from 'remark-slate';
unified()
.use(markdown)
.use(slate)
.process(fs.readFileSync('example.md'), (err, file) => {
if (err) throw err;
console.log({ file });
});
```
And `example.md` looks like this:
```markdown
# Heading one
## Heading two
### Heading three
#### Heading four
##### Heading five
###### Heading six
Normal paragraph
_italic text_
**bold text**
~~strike through text~~
[hyperlink](https://jackhanford.com)
> A block quote.
- bullet list item 1
- bullet list item 2
1. ordered list item 1
1. ordered list item 2
```
Results in the following Slate object
Reveal
```json
[
{
"type": "heading_one",
"children": [
{
"text": "Heading one"
}
]
},
{
"type": "heading_two",
"children": [
{
"text": "Heading two"
}
]
},
{
"type": "heading_three",
"children": [
{
"text": "Heading three"
}
]
},
{
"type": "heading_four",
"children": [
{
"text": "Heading four"
}
]
},
{
"type": "heading_five",
"children": [
{
"text": "Heading five"
}
]
},
{
"type": "heading_six",
"children": [
{
"text": "Heading six"
}
]
},
{
"type": "paragraph",
"children": [
{
"text": "Normal paragraph"
}
]
},
{
"type": "paragraph",
"children": [
{
"text": "italic text",
"italic": true
}
]
},
{
"type": "paragraph",
"children": [
{
"text": "bold text",
"italic": true
}
]
},
{
"type": "paragraph",
"children": [
{
"text": "strike through text",
"strikeThrough": true
}
]
},
{
"type": "paragraph",
"children": [
{
"type": "link",
"link": "https://jackhanford.com",
"children": [
{
"text": "hyperkink"
}
]
}
]
},
{
"type": "block_quote",
"children": [
{
"type": "paragraph",
"children": [
{
"text": "A block quote."
}
]
}
]
},
{
"type": "ul_list",
"children": [
{
"type": "list_item",
"children": [
{
"type": "paragraph",
"children": [
{
"text": "bullet list item 1"
}
]
}
]
},
{
"type": "list_item",
"children": [
{
"type": "paragraph",
"children": [
{
"text": "bullet list item 2"
}
]
}
]
}
]
},
{
"type": "ol_list",
"children": [
{
"type": "list_item",
"children": [
{
"type": "paragraph",
"children": [
{
"text": "ordered list item 1"
}
]
}
]
},
{
"type": "list_item",
"children": [
{
"type": "paragraph",
"children": [
{
"text": "ordered list item 2"
}
]
}
]
}
]
}
]
```
### Miscellaneous
remark-slate makes some assumptions around unordered and ordered lists, the package pairs nicely with [slate-edit-list](https://github.com/productboard/slate-edit-list#readme)
## Local Development
Below is a list of commands you will probably find useful.
### `npm start` or `yarn start`
Runs the project in development/watch mode. The project will be rebuilt upon changes.
Your library will be rebuilt if you make edits.
### `npm run build` or `yarn build`
Bundles the package to the `dist` folder.
The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).
### `npm test` or `yarn test`
Runs the test watcher (Jest) in an interactive mode.
By default, runs tests related to files changed since the last commit.
## License (MIT)
```
WWWWWW||WWWWWW
W W W||W W W
||
( OO )__________
/ | \
/o o| MIT \
\___/||_||__||_|| *
|| || || ||
_||_|| _||_||
(__|__|(__|__|
```
Copyright © 2020-present [Jack Hanford](http://jackhanford.com), [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[downloads-badge]: https://img.shields.io/npm/dm/remark-slate.svg
[downloads]: https://www.npmjs.com/package/remark-slate
[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-slate.svg
[size]: https://bundlephobia.com/result?p=remark-slate
[remark]: https://github.com/remarkjs/remark