Skip to content

Add a dedicated help page and document some common SVG edits. #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dominickng wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Add a dedicated help page and document some common SVG edits. #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions help.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!doctype html>
<html>
<head>
<meta charset="UTF-8">
<title>Help for Skiafy</title>
<link rel="stylesheet" type="text/css" href="main.css">
<script src="main.js"></script>
</head>

<h1>Skiafy Help</h1>

<p class="caveat">Caveat emptor! This program makes lots of assumptions. Its
output is just a starting point; you may have to manipulate it further.</p>

<p>Strongly consider pre-processing the SVG source with <a
href="https://jakearchibald.github.io/svgomg/">Jake Archibald’s SVGOMG tool</a>
(a web interface to <a href="https://github.com/svg/svgo/">the SVGO SVG
optimizer</a>).</p>

<h3>Common SVG edits</h3>

<p>Remove all &lt;defs&gt; tags, and move their contents to a &lt;g&gt;
section, e.g.</p>
<ul>
<li>&lt;defs&gt; &lt;path A /&gt; &lt;/defs&gt; &lt;g&gt;
&lt;path B /&gt; &lt;/g&gt; becomes &lt;g&gt; &lt;path A /&gt;
&lt;path B /&gt; &lt;/g&gt;</li>
</ul>

<p>Remove all &lt;use&gt; tags, and move the attributes to the element with an
"id" matching the &lt;use&gt; "xlink:href". Remove the "id" attribute, e.g.</p>
<ul>
<li>&lt;path id="a"/&gt; &lt;use fill="#000" xlink:href="#a"/&gt; becomes
&lt;path fill="#000"/&gt;</li>
</ul>

<p>Sometimes an additional square border may need to be removed</p>
<ul>
<li>&lt;path d="M0 0h20v20H0z"/&gt; will draw a border around the icon, remove
if it isn't needed</li>
</ul>

</html>
8 changes: 1 addition & 7 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,7 @@

<h1>Skiafy</h1>

<p class="caveat">Caveat emptor! This program makes lots of assumptions. Its
output is just a starting point; you may have to manipulate it further.</p>

<p>Strongly consider pre-processing the SVG source with <a
href="https://jakearchibald.github.io/svgomg/">Jake Archibald’s SVGOMG tool</a>
(a web interface to <a href="https://github.com/svg/svgo/">the SVGO SVG
optimizer</a>).</p>
<p>Read the <a href="help.html">Help</a> to get started.</p>

<div id="top-stuff">
<div id="input-stuff">
Expand Down