Update README.md (#844)

formatting + syntax highlighting code blocks
master
smed79 2022-11-05 19:32:38 +01:00 committed by GitHub
parent e08648c8f5
commit 1cd30205d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 10 deletions

View File

@ -24,19 +24,19 @@ Please let us know with an issue or a discussions if you wish to contribute.
Thanks to **Netlify**, you can access the following builds from your favorite browser: Thanks to **Netlify**, you can access the following builds from your favorite browser:
[Try SVGEdit V7 (master branch on github)](https://svgedit.netlify.app/editor/index.html) - [Try SVGEdit V7 (master branch on github)](https://svgedit.netlify.app/editor/index.html)
- [Try SVGEdit V7 (latest published version on npm)](https://unpkg.com/svgedit@latest/dist/editor/index.html)
[Try SVGEdit V7 (latest published version on npm)](https://unpkg.com/svgedit@latest/dist/editor/index.html)
### Prior V7: ### Prior V7:
We recommand using the V7 version but for older browsers or some abandoned features, you may need to access to old versions of SVGEdit. We recommand using the V7 version but for older browsers or some abandoned features, you may need to access to old versions of SVGEdit.
[Try SVGEdit 6.1.0 here](https://60a0000fc9900b0008fd268d--svgedit.netlify.app/editor/index.html) - [Try SVGEdit 6.1.0 here](https://60a0000fc9900b0008fd268d--svgedit.netlify.app/editor/index.html)
[Try SVGEdit 5.1.0 here](https://unpkg.com/svgedit@5.1.0/editor/svg-editor.html) - [Try SVGEdit 5.1.0 here](https://unpkg.com/svgedit@5.1.0/editor/svg-editor.html)
Additional tip: you may try a version released on NPM using unpkg for example with version 3.2.0: Additional tip: you may try a version released on NPM using unpkg for example with version 3.2.0
[https://unpkg.com/svgedit@3.2.0/editor/svg-editor.html](https://unpkg.com/svgedit@3.2.0/editor/svg-editor.html)
- [https://unpkg.com/svgedit@3.2.0/editor/svg-editor.html](https://unpkg.com/svgedit@3.2.0/editor/svg-editor.html)
## I want to host SVGEdit in my environment ## I want to host SVGEdit in my environment
@ -70,7 +70,7 @@ If you intend to contribute on a regular basis, let us know so we can add you in
V7 is changing significantly the way to integrate and customize SVG-Edit. You can have a look to index.html to see how you can insert a div element into your HTML code and inject the editor into the div. V7 is changing significantly the way to integrate and customize SVG-Edit. You can have a look to index.html to see how you can insert a div element into your HTML code and inject the editor into the div.
``` ```html
<head> <head>
<!-- You need to include the CSS for SVGEdit somewhere in your application --> <!-- You need to include the CSS for SVGEdit somewhere in your application -->
<link href="./svgedit.css" rel="stylesheet" media="all"></link> <link href="./svgedit.css" rel="stylesheet" media="all"></link>
@ -84,7 +84,7 @@ V7 is changing significantly the way to integrate and customize SVG-Edit. You ca
<script type="module"> <script type="module">
/* You need to call the Editor and load it in the <div> */ /* You need to call the Editor and load it in the <div> */
import Editor from './Editor.js' import Editor from './Editor.js'
/* for available options see the file `docs/tutorials/ConfigOptions.md */ /* for available options see the file `docs/tutorials/ConfigOptions.md` */
const svgEditor = new Editor(document.getElementById('container')) const svgEditor = new Editor(document.getElementById('container'))
/* initialize the Editor */ /* initialize the Editor */
svgEditor.init() svgEditor.init()
@ -98,6 +98,7 @@ V7 is changing significantly the way to integrate and customize SVG-Edit. You ca
</script> </script>
</html> </html>
``` ```
## I want to build my own svg editor ## I want to build my own svg editor
You can just use the underlying canvas and use it in your application with your favorite framework. You can just use the underlying canvas and use it in your application with your favorite framework.
See example in the demos folder or the svg-edit-react repository. See example in the demos folder or the svg-edit-react repository.
@ -124,7 +125,7 @@ To activate:
- "npm run build" from the extension folder "src/editor/react-extensions/react-test" in order to create the bundle for the extension. - "npm run build" from the extension folder "src/editor/react-extensions/react-test" in order to create the bundle for the extension.
- modify "index.html" to activate the extension as a userExtensions - modify "index.html" to activate the extension as a userExtensions
``` ```javascript
svgEditor.setConfig({ svgEditor.setConfig({
allowInitialUserOverride: true, allowInitialUserOverride: true,
extensions: [], extensions: [],
@ -142,4 +143,5 @@ svgEditor.setConfig({
# Hosting # Hosting
SVGedit versions are deployed to: SVGedit versions are deployed to:
[![Deploys by Netlify](https://www.netlify.com/img/global/badges/netlify-color-accent.svg)](https://www.netlify.com) [![Deploys by Netlify](https://www.netlify.com/img/global/badges/netlify-color-accent.svg)](https://www.netlify.com)