# rough-markup
**Repository Path**: zhi/rough-markup
## Basic Information
- **Project Name**: rough-markup
- **Description**: A markup-style wrapper for `rough.js`.
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-07
- **Last Updated**: 2021-03-13
## Categories & Tags
**Categories**: Uncategorized
**Tags**: rough
## README
Rough Markup
============
The SVG-like markup language for [Rough.js][], a small (<9 kB) graphics library that lets you draw in a sketchy, hand-drawn-like, style.
It's intended to be a utility lib to make [Rough.js][] method calls more elegant instead of [transforming SVG into rough style](https://www.npmjs.com/package/rougher).
Here's an example for drawing:
```js
import { render, svg } from "rough-markup";
render(
svg`
`,
"#canvas"
);
```
Which renders into an rough-style image into canvas:
Installation
------------
Via [npm][] (or other alternatives like yarn, pnpm):
```sh
npm i rough-markup
```
Or use directly in your HTML via CDN(like jsdelivr):
```html
```
API
------------
It provides one-to-one implementation to [Rough.js][]. P
Example
------------
See the example folder for more usage.
[Rough.js]: http://roughjs.com "The Rough.js Project"
[npm]: http://npmjs.com "The NPM community"