@tomasvn/svgstore 3.1.4 → 3.1.5

package/.github/workflows/pages.yml

@@ -0,0 +1,33 @@
+name: Deploy documentation to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/configure-pages@v5
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# 3.1.5
+
+- Deployed docs site
+
 # 3.1.4
 
     - Closes [#36][https://github.com/svgstore/svgstore/issues/36]

package/docs/index.html

@@ -0,0 +1,76 @@
+<!doctype html>
+<html lang="en">
+<head>
+	<meta charset="utf-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<meta name="description" content="Documentation and examples for svgstore, a tool for combining SVG files into a sprite.">
+	<title>svgstore documentation</title>
+	<style>
+		:root {
+			color-scheme: light;
+			font-family: system-ui, sans-serif;
+			color: #20232a;
+			background: #f7f8fa;
+		}
+		body {
+			box-sizing: border-box;
+			max-width: 760px;
+			margin: 0 auto;
+			padding: 4rem 1.5rem;
+			line-height: 1.6;
+		}
+		h1, h2 {
+			line-height: 1.2;
+		}
+		a {
+			color: #0969da;
+		}
+		code {
+			padding: 0.15rem 0.35rem;
+			border-radius: 4px;
+			background: #e9edf2;
+		}
+		pre {
+			overflow-x: auto;
+			padding: 1rem;
+			border-radius: 6px;
+			background: #20232a;
+			color: #f7f8fa;
+		}
+		pre code {
+			padding: 0;
+			background: none;
+			color: inherit;
+		}
+		nav {
+			display: flex;
+			flex-wrap: wrap;
+			gap: 1rem;
+			margin-top: 2rem;
+		}
+	</style>
+</head>
+<body>
+	<main>
+		<h1>svgstore</h1>
+		<p>Combine multiple SVG files into one sprite using <code>&lt;symbol&gt;</code> elements.</p>
+
+		<h2>Quick start</h2>
+		<p>Install the package and add SVG files to a sprite:</p>
+		<pre><code>npm install @tomasvn/svgstore</code></pre>
+		<pre><code>const svgstore = require('@tomasvn/svgstore');
+const fs = require('fs');
+
+const sprite = svgstore()
+  .add('icon', fs.readFileSync('./icon.svg', 'utf8'));
+
+fs.writeFileSync('./sprite.svg', sprite);</code></pre>
+
+		<nav aria-label="Documentation links">
+			<a href="examples/">View the examples</a>
+			<a href="https://github.com/tomasvn/svgstore#api">API reference</a>
+			<a href="https://github.com/tomasvn/svgstore">GitHub repository</a>
+		</nav>
+	</main>
+</body>
+</html>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomasvn/svgstore",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "description": "Combines mulitple svg files into one.",
   "scripts": {
     "lint": "npx eslint --fix \"{src,test}/**/*.js\" && npx prettier --write \"{src,test}/**/*.js\"",

package/readme.md

@@ -6,9 +6,14 @@ Combines multiple SVG files into one using `<symbol>` elements which you may [`<
 
 ## NOTE
 
--   This is only a fork of original work, it implements this [PR #33](https://github.com/svgstore/svgstore/pull/33) from original work
--   Adds linear gradient proccessing
--   **NOT MAINTAINED**
+<blockquote>
+    <strong>NOTE:</strong> This is a fork of original work, released with patched fixes <br />
+    SEE: <a href="./CHANGELOG.md">Changelog</a>
+</blockquote>
+
+## Documentation
+
+Visit the [svgstore documentation site](https://tomasvn.github.io/svgstore/) for a quick start and examples.
 
 ## Install