hazho / SVGencode

A simple tool to convert an SVG into different formats, ready for use in CSS and HTML.

SVGEncoder.com Website

Convert your SVG to common encodings for CSS & HTML.

1. Table of Contents

• 1. Table of Contents
• 2. About The Project
  • 2.1. Built With
  • 2.2. Installation
• 3. Usage
  • 3.1. Current Encode List
  • 3.2. Tools
• 4. Customising
• 5. Troubleshooting
• 6. Contributing
• 7. License
• 8. Contact
• 9. Changelog

2. About The Project

SVGEncode.com

This is just a small little one-day project to learn gatsby with netlify. I'm always using yoksel's https://yoksel.github.io/url-encoder/ project, but I sometimes need the result in a Base64 encoded format with a backgroung-image.

So I thought whis might be a good little project to implement.

(back to top)

2.1. Built With

This project was built with the following frameworks, technologies and software.

• Gatsby

(back to top)

2.2. Installation

These are the steps to get up and running.

1. Clone the repo

   git clone https://github.com/IORoot/SVGencode

2. Install package.json

   npm install

3. Run gatsby

   gatsby clean && gatsby develop

(back to top)

3. Usage

3.1. Current Encode List

The current list of conversions are:

• URL-Encoded (Quotes and Spaces excluded)
• URL-Encoded CSS background-image:url()
• URL-Encoded <Img> Tag
• URL-Encoded <Object> Tag
• BASE64-Encoded (Quotes and Spaces excluded)
• BASE64-Encoded CSS background-image:url()
• BASE64-Encoded <Img> Tag
• BASE64-Encoded <Object> Tag
• Encoded with Javascript encodeURI()
• Encoded with Javascript encodeURIComponent()

3.2. Tools

There are some extra functions that are useful for manipulating SVGs

• One-liner. Removes all new-lines and whitespace.
• Single-Quotes. Switch any double-quotes for singles.
• Double-Quotes. Switch any single-quotes for doubles.
• No Colour. Removes the following attributes:
  • fill=""
  • fill-rule=""
  • stroke=""
  • stroke-width=""
• No Transforms. Removes all transform="" attribute.
• No Groups. Removes all group <g> and </g> tags.

4. Customising

None.

5. Troubleshooting

None

(back to top)

6. Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

7. License

Distributed under the MIT License.

MIT License

Copyright (c) 2022 Andy Pearson

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.

(back to top)

8. Contact

Author Link: https://github.com/IORoot

(back to top)

9. Changelog

v1.0.0 - First version.