@natura11y/icons 2.2.0

package/.fantasticonrc.js

@@ -0,0 +1,26 @@
+const codepoints = require('./dist/natura11y-icons.json');
+
+module.exports = {
+  inputDir: './original-svg', // (required)
+  outputDir: './dist', // (required)
+  fontTypes: ['ttf', 'woff2', 'woff'],
+  assetTypes: ['css', 'json', 'html'],
+  name: 'natura11y-icons',
+  codepoints: codepoints,
+  prefix: 'icon',
+  selector: '.icon',
+  tag: 'span',
+  formatOptions: {
+    json: {
+      indent: 3
+    }
+  },
+  pathOptions: {
+    html: './dist/index.html',
+    css: './dist/natura11y-icons.css',
+    json: './dist/natura11y-icons.json',
+    ttf: './dist/natura11y-icons.ttf',
+    woff: './dist/natura11y-icons.woff',
+    woff2: './dist/natura11y-icons.woff2'
+  }
+};

package/README.md

@@ -0,0 +1,43 @@
+# Natura11y Icons
+
+Use Natura11y's open source icon font, or use this package as the starting point for your own icon library.
+
+---
+
+## CDN
+
+```html
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@natura11y/icons@2.2.0/dist/natura11y-icons.min.css">
+```
+
+---
+
+## Build Icons
+
+1. Save your SVGs to `./original-svg`.
+
+2. Install package dependencies:
+
+```bash
+npm install
+```
+
+3. Optimize SVGs, build the icon font, and write the minified CDN stylesheet:
+
+```bash
+npm run build:icons
+```
+
+---
+
+## The icon font
+
+The build generates `dist/natura11y-icons.css`, `dist/natura11y-icons.min.css`, font files, a sprite, and icon metadata. You can customize the generated icon font with `.fantasticonrc.js`.
+
+---
+
+Related:
+
+- [NPM: @natura11y/icons](https://www.npmjs.com/package/@natura11y/icons)
+- [Repo: Natura11y Core](https://github.com/Natura11y/core)
+- [Docs: Natura11y Docs](https://gonatura11y.com)