@stacksjs/iconify-academicons 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +53 -0
  2. package/package.json +41 -0
package/README.md ADDED
@@ -0,0 +1,53 @@
1
+ # @stacksjs/iconify-academicons
2
+
3
+ Academicons icons for stx from Iconify.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ bun add @stacksjs/iconify-academicons
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ### In stx templates
14
+
15
+ ```html
16
+ <script>
17
+ import { home } from '@stacksjs/iconify-academicons'
18
+ import { renderIcon } from '@stacksjs/iconify-core'
19
+
20
+ export const homeIcon = renderIcon(home, { size: 24, color: 'currentColor' })
21
+ </script>
22
+
23
+ <div class="icon">
24
+ {!! homeIcon !!}
25
+ </div>
26
+ ```
27
+
28
+ ### In TypeScript/JavaScript
29
+
30
+ ```typescript
31
+ import { home, account, settings } from '@stacksjs/iconify-academicons'
32
+ import { renderIcon } from '@stacksjs/iconify-core'
33
+
34
+ const svg = renderIcon(home, {
35
+ size: 24,
36
+ color: '#000000',
37
+ })
38
+ ```
39
+
40
+ ## Available Icons
41
+
42
+ This package contains 158 icons from Academicons.
43
+
44
+ ## License
45
+
46
+ Open Font License
47
+
48
+ License: https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL
49
+
50
+ ## Credits
51
+
52
+ - Icons: James Walsh (https://github.com/jpswalsh/academicons)
53
+ - Iconify: https://iconify.design/
package/package.json ADDED
@@ -0,0 +1,41 @@
1
+ {
2
+ "name": "@stacksjs/iconify-academicons",
3
+ "type": "module",
4
+ "version": "0.0.1",
5
+ "description": "Academicons icons for stx from Iconify",
6
+ "author": "James Walsh",
7
+ "license": "OFL-1.1",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "https://github.com/stacksjs/stx.git",
11
+ "directory": "packages/iconify-academicons"
12
+ },
13
+ "keywords": [
14
+ "iconify",
15
+ "icons",
16
+ "svg",
17
+ "academicons",
18
+ "Academicons",
19
+ "stx"
20
+ ],
21
+ "sideEffects": false,
22
+ "exports": {
23
+ ".": {
24
+ "types": "./dist/index.d.ts",
25
+ "import": "./dist/index.js"
26
+ },
27
+ "./*": "./dist/*"
28
+ },
29
+ "main": "./dist/index.js",
30
+ "module": "./dist/index.js",
31
+ "types": "./dist/index.d.ts",
32
+ "files": [
33
+ "dist"
34
+ ],
35
+ "scripts": {
36
+ "build": "bun build.ts"
37
+ },
38
+ "dependencies": {
39
+ "@stacksjs/iconify-core": "^0.1.12"
40
+ }
41
+ }