Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cancerberosgx/mujer
Practical SVG processing tools for optimize, transform, format conversion, and more, supporting node.js, browser and CLI.
https://github.com/cancerberosgx/mujer
Last synced: about 1 month ago
JSON representation
Practical SVG processing tools for optimize, transform, format conversion, and more, supporting node.js, browser and CLI.
- Host: GitHub
- URL: https://github.com/cancerberosgx/mujer
- Owner: cancerberoSgx
- License: mit
- Created: 2019-06-24T18:51:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T00:59:46.000Z (almost 2 years ago)
- Last Synced: 2024-11-02T10:34:32.544Z (about 2 months ago)
- Language: TypeScript
- Size: 4.58 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mujer
# Contents
- [Summary](#summary)
- [Install](#install)
- [Tools](#tools)
* [optimizeSvg](#optimizesvg)
+ [Command line](#command-line)
+ [API](#api)
+ [Options](#options)
* [svg2pdf](#svg2pdf)
+ [Command line](#command-line-1)
+ [API](#api-1)
* [simplifyPaths](#simplifypaths)
+ [Command line](#command-line-2)
+ [API](#api-2)
+ [Options](#options-1)
- [TODO / Status / Roadmap](#todo--status--roadmap)
# Summary
Practical tools for vector graphics:
* High level - easy to use
* APIs for Node.js and Browser
* Command line tools
* Optimization
* Transformations
* Format conversion
* more to come...
# Install
```sh
npm install mujer
```
# Tools
## optimizeSvg
Minimizes SVG code size using [svgo](TODO) and optionally simplifyPaths utility.
### Command line
```sh
svg-optimize --input "some/**/*.svg" --output output/folder
```
### API
```ts
import {optimizeSvg} from 'mujer'
// We must pass the SVG code as input, in this case we read a file in node
// In the browser we could obtain the SVG code with a request or from a DOM Element
var output = await optimizeSvg({
input: readFileSync('foo/bar.svg').toString()
})
// In node we could write the output to a file:
writeFileSync('foo/bar_optimized.svg', output)
// in the browser I could render in the document:
document.getElementById('svg-container').innerHTML = output
```
### Options
TODO
## svg2pdf
### Command line
```sh
svg2pdf --input "some/**/*.svg" --output output/folder
```
### API
```ts
import {svg2pdf} from 'mujer'
const pdf = await svg2pdf({
input: './test/assets/test2.svg',
width: 1000,
height: 1000
})
// in node.js I could save it to a file
writeFileSync('output.pdf', pdf)
// in the browser I could make the user to download
// TODO: example
```
## simplifyPaths
### Command line
```sh
svg-simplify-paths --input "some/**/*.svg" --output output/folder --tolerance 3
```
### API
```ts
import {svg2pdf} from 'mujer'
var output = await simplifyPaths({
input: 'test2.svg',
width: 1000,
height: 1000,
tolerance: 5
})
// in node.js I could save it to a file
writeFileSync('test2_simplified.svg', output)
// in the browser I could render in the document:
document.getElementById('svg-container').innerHTML = output
```
### Options
TODO
# TODO / Status / Roadmap
- [ ] Command line